Add README

This commit is contained in:
Yash Karandikar 2021-10-04 19:03:44 -05:00
parent 2d7bfa13fa
commit 4f21acb78b
Signed by: karx
GPG key ID: A794DA2529474BA5

22
concurrency/README.md Normal file
View file

@ -0,0 +1,22 @@
# ConCurrency
[Live App](https://karx.xyz/rgl/concurrency/)
## Running Locally
1. Install dependencies
```bash
cd /path/to/concurrency
yarn install
```
2. Build project (be sure to supply the API_URL environment variable)
- Linux/MacOS:
```bash
API_URL=https://v6.exchangerate-api.com/v6/api-key/latest/USD/ yarn build
```
- Windows:
I'm not sure how to set environment variables on Windows, if anyone does, PRs are welcome!
3. Open in browser
Simply open the `index.html` file in the `public/` directory.
<small>Created using [exchangerate-api](https://exchangerate-api.com) and React with TypeScript.</small>