azpsen/tailfin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add configuration instructions

Browse Source
This commit is contained in:
april 2024-01-05 11:44:03 -06:00
parent 02c45bbc63
commit e62fb0ff5f
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
web/README.md
View File

@ -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 <a name="configuration"></a>
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 <a name="usage"></a>
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 <a name="roadmap"></a>
- [x] Basic API sessions and data fetching