Skip to content
This repository has been archived by the owner on Nov 24, 2022. It is now read-only.

Commit

Permalink
refactor: inclusion in prototype services readme (#272)
Browse files Browse the repository at this point in the history
* refactor: adding the prototype services to the readme

* Update README.md

added instructions on how to use docker-compose

Co-authored-by: Raphael Flechtner <39338561+flechtnergalani@users.noreply.github.com>
  • Loading branch information
Dudleyneedham and rflechtner authored Jul 2, 2020
1 parent 005af0b commit c4810cd
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,36 @@
The KILT demo client demonstrates the functionality of the KILT SDK and acts as a playground for KILT use cases.

## Installation for local development
To use the demo client locally, you have to install all dependencies with yarn.
Because the demo client will try to connect to our [prototype services](https://github.com/KILTprotocol/prototype-services) and [mashnet-node](https://github.com/KILTprotocol/mashnet-node), we recommend spinning up the whole stack using `docker-compose` (see below).

To run the demo client natively, you have to install all dependencies with yarn.
```
yarn install
```

## Run
To build it and launch a dev server, run
Then start a develop build with
```
yarn start
```
The client can now be accessed with a browser on http://localhost:3000.

Follow the setup steps from our [prototype services](https://github.com/KILTprotocol/prototype-services) and [mashnet-node](https://github.com/KILTprotocol/mashnet-node) to get these running.

## Run in docker container

### Build docker image
Use docker-compose to build and run the demo client and its dependencies (prototype services and mashnet node) in a set of docker containers.
```
docker build -t kilt/prototype-client .
docker-compose up demo-client
```

### Run docker image
Again, the client is now available on http://localhost:3000.
Stop and remove all containers (resetting state) with
```
docker run -p 80:80 kilt/prototype-client
docker-compose down -v
```
The `src` directory will be mounted to the demo-client's container, which applys all changes on save.
If you make changes that require reinstalling dependencies, rebuild the images with
```
docker-compose up --build demo-client
```
The client can now be accessed with a browser on http://localhost:80


## Readme from "Create React App"
This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).
Expand Down

0 comments on commit c4810cd

Please sign in to comment.