xevion/linkpulse
1
0
Fork 0
mirror of https://github.com/Xevion/linkpulse.git synced 2025-12-07 07:15:33 -06:00
Code Issues Packages Projects Releases Wiki Activity

document frontend setup, backend startup, TODOs

Browse Source
This commit is contained in:
Xevion
2024-10-16 01:28:20 -05:00
parent 30d9d96838
commit c7751097b2
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -11,6 +11,18 @@ This is an empty project right now. It merely holds a simplistic FastAPI server
## Setup
### Frontend
1. Install Node.js 22.x
<!-- TODO: Add details on installation practices, asdf + nvm -->
3. Install `pnpm` with `npm install -g pnpm`
4. Install frontend dependencies with `pnpm install`
5. Start the frontend server with `./run.sh`
<!-- TODO: Get local Caddy server with Vite builds working. -->
### Backend
1. Install [`pyenv`][pyenv] or [`pyenv-win`][pyenv-win]
- Install Python 3.12 (`pyenv install 3.12`)
@@ -20,7 +32,9 @@ This is an empty project right now. It merely holds a simplistic FastAPI server
- Requires `pipx`, see [here][pipx]
- Install with `pipx install poetry`
3. Install backend dependencies with `poetry install`
3. Install backend dependencies with `poetry install`.
4. Start the backend server with `./run.sh`
## Usage