From 4f21acb78b0a54c34333120862a0038aae9dd768 Mon Sep 17 00:00:00 2001 From: Yash Karandikar Date: Mon, 4 Oct 2021 19:03:44 -0500 Subject: [PATCH] Add README --- concurrency/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 concurrency/README.md diff --git a/concurrency/README.md b/concurrency/README.md new file mode 100644 index 0000000..d5c1be1 --- /dev/null +++ b/concurrency/README.md @@ -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. + +Created using [exchangerate-api](https://exchangerate-api.com) and React with TypeScript. \ No newline at end of file