IXO Webclient

This project serves as the Front-end Web platform for the IXO ecosystem.

Built Using

Built to work with

Back-end for all API calls and DID management.

• IXO Module
• IXO Key Extension [ Depreciated in favor of upcoming mobile client]

Setup

yarn install

Running

Development

cp .env-example .env

yarn run dev

When changing file names please ensure to have run the following command:

git config core.ignorecase false

Build & production

yarn build
yarn start

Deployment

Netlify

Akash

Docker

• Clone the repo, select between dev or impact branches

git clone https://github.com/ixofoundation/ixo-webclient && cd ixo-webclient && git checkout impact

• Rename the .env.example to .env and configure .env
• Configure the nginx config default.conf as needed
• Now build the docker image with

docker build -t ixo-webclient:latest .

Now run the image with either of these two options.

Docker run

• -p specifies the port used to the last number must replicate was is seen in default.conf

docker run -p 3000:3000 ixo-webclient:latest

Docker-compose

Modify the port value to the value specified in default.conf if it was changed

docker-compose up -d

Akash

Architecture & flow

Styling

IXO Web is styled using styled components. all styling information is kept within a component. The main file - App.tsx contains theme information, where you can add variables for use through the Web App.

Container Components

• App
  Displays state-based views for projects lists (eg. Overivew, Loading, Dashboard).

• ProjectContainer
  Contains logic for all single-project data and views (eg. Overview, Dashboard, List Providers).

• ProjectsContainer
  Contains logic for listing projects and initiation of IXO-Module & IXO-Keysafe Objects.

• HeaderContainer
  Contains logic related to network status.

License

Apache 2.0 license