caremyway-client/README.md

39 lines
1.3 KiB
Markdown
Raw Normal View History

2017-08-29 21:29:44 +00:00
# CareMyWay Client
2017-08-24 03:10:45 +00:00
2017-08-29 21:29:44 +00:00
Generated using [create-react-app](https://github.com/facebookincubator/create-react-app).
## Quickstart (Development)
* Ensure the server is up and running locally.
* [CareMyWay](https://gogs.tannercollin.com/tanner/caremyway)
* Install dependencies with `yarn install`
* Run the client with `yarn start`
Now you can visit `localhost:3000` from your browser.
## Environment Variables
The environment variables are embedded during the build time. For more information, please refer to the [docs](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-custom-environment-variables).
| Environment Variable | Default Value | Description |
| ------------------------- |:-------------------------:| -------------------------------:|
| `REACT_APP_API_ENDPOINT` | `"http://localhost:8000"` | Server API endpoint |
| `REACT_APP_REDUX_LOGGING` | ` ` | Set any value for Redux logging |
## Production
To build the production instance of this application, run the following:
```bash
export REACT_APP_API_ENDPOINT="http://dev.tannercollin.com:8000/" && yarn build
# then, to serve the production site locally
yarn global add serve
serve -s build --port 3000
```
2017-08-29 21:29:44 +00:00
## Testing
To test the react app, call `yarn test`.