diff --git a/web/README.md b/web/README.md index 9fa11ee..55dc195 100644 --- a/web/README.md +++ b/web/README.md @@ -14,6 +14,7 @@ - [About](#about) - [Getting Started](#getting_started) - [Configuration](#configuration) +- [Configuration](#configuration) - [Usage](#usage) - [Roadmap](#roadmap) @@ -54,12 +55,14 @@ $ npm install $ npm run build && npm run start ``` +## Configuration + +The URL for the Tailfin API can be set with the environment variable `TAILFIN_API_URL`. It defaults to `http://localhost:8081`, which assumes the API runs on the same machine and uses the default port. + ## Usage Once running, the web app can be accessed at `localhost:3000` -Currently, this only supports a local Tailfin API instance running at `localhost:8081`. This can be modified by manually editing `app/util/api.ts`. - ## Roadmap - [x] Basic API sessions and data fetching