Skip to content
This repository has been archived by the owner on Jan 20, 2024. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
Add build instructions (fixes #19)
  • Loading branch information
tdemin committed Oct 26, 2019
1 parent e1ad366 commit f2a5c61
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Expand Up @@ -3,6 +3,36 @@
The web client for [Project Amber](/tdemin/amber), made with React,
Redux, and TypeScript.

#### Running the app locally

###### Development

Simply run:

% yarn install --dev
% yarn start

Set the `REACT_APP_APIURI` environment variable in case you're testing against
a local server. It should point to the base URI for all API requests, namely
`https://amber.h.tdem.in/api`.

###### Docker

Run:

% docker build . -t amber_web
% docker run -it -p 8080:80 amber_web

If you're running your own API server, be sure to set the
`REACT_APP_APIURI` flag when building:

% docker build . -t amber_web --build-arg REACT_APP_APIURI=https://your.tld/api

#### Development

The source code of this app is formatted automatically with Prettier. Be sure
to run `yarn beautify` and `yarn lint` before sending a pull request!

#### License

This program is MIT-licensed. See [LICENSE.txt](LICENSE.txt) for details.

0 comments on commit f2a5c61

Please sign in to comment.