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

Fix README formatting

Browse Source
This commit is contained in:
april 2024-01-05 11:45:39 -06:00
parent e62fb0ff5f
commit 0bfdc4f8e5
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
web/README.md
View File

@ -13,8 +13,9 @@
- [About](#about) - [About](#about)
- [Getting Started](#getting_started) - [Getting Started](#getting_started)
- [Configuration](#configuration) - [Prerequisites](#prerequisites)
- [Configuration](#configuration) - [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage) - [Usage](#usage)
- [Roadmap](#roadmap) - [Roadmap](#roadmap)
@ -29,12 +30,12 @@ Since I could not find any ready-made self-hosted logbooks, I decided to make my
## Getting Started <a name="getting_started"></a> ## Getting Started <a name="getting_started"></a>
### Prerequisites ### Prerequisites <a name="prerequisites"></a>
- npm - npm
- [tailfin-api](https://github.com/azpsen/tailfin-api) - [tailfin-api](https://github.com/azpsen/tailfin-api)
### Installation ### Installation <a name="installation"></a>
1. Clone the repo 1. Clone the repo
@ -55,7 +56,7 @@ $ npm install
$ npm run build && npm run start $ npm run build && npm run start
``` ```
## Configuration <a name="configuration"></a> ### 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. 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.