linkpulse/README.md

linkpulse

This is an empty project right now. It merely holds a simplistic FastAPI server to showcase Railway.

• Windows WSL is recommended for development. See here for setup instructions.

Project Structure

• /backend A backend server using FastAPI, managed with Poetry.
• /frontend A frontend server using React, managed with pnpm.

Setup

1. Install pyenv or pyenv-win

   • Install Python 3.12 (pyenv install 3.12)

2. Install poetry

   • Requires pipx, see here
   • Install with pipx install poetry

3. Install backend dependencies with poetry install

Usage

• A fully editable (frontend and backend), automatically reloading project is possible, but it requires two terminals.
  • Each terminal must start in the respective directory (/backend and /frontend).
  • ./run.sh will start the development server in the respective directory.
    • The first argument is optional, but can be used in the frontend to compile & serve the backend.