Browse Source

Add info about using the embedded frontend into the README

This should be the default way of using the project as it gives a better
experience to the users, unless someone needs to work on the frontend code.
feature/force-stop-button
Mariusz Klochowicz 3 years ago
parent
commit
dc165e8f27
No known key found for this signature in database GPG Key ID: 470C865699C8D4D
  1. 33
      README.md

33
README.md

@ -35,9 +35,36 @@ The maker and taker frontend depend on the respective daemon running.
We use a separate react projects for hosting taker and maker frontends.
At the moment you will need a browser extension to allow CORS headers like `CORS Everywhere` ([Firefox Extension](https://addons.mozilla.org/en-US/firefox/addon/cors-everywhere/)) to use the frontends.
### Building the frontends
### Taker
The latest version of the built frontends will be embedded by `cargo` inside
their respective daemons and automatically served when the daemon starts.
Embedded frontend is served on ports `8000` and `8001` by default.
This means that it is highly recommended to build the frontend _before_ the daemons.
#### Taker
```bash
cd taker-frontend
yarn install
yarn build
```
#### Maker
```bash
cd maker-frontend
yarn install
yarn build
```
### Developing frontend code
If hot-reloading of the app is required, frontend can be started in development mode.
Development frontend is served on ports `3000` and `3001` by default.
#### Taker
```bash
cd taker-frontend
@ -45,7 +72,7 @@ yarn install
yarn dev
```
### Maker
#### Maker
```bash
cd maker-frontend

Loading…
Cancel
Save