mirror of
https://github.com/Xevion/linkpulse.git
synced 2025-12-06 11:15:34 -06:00
5360d245436712cb48e917ffe4d4e4f0ee0d73c1
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
/backendA backend server using FastAPI, managed with Poetry./frontendA frontend server using React, managed with pnpm.
Setup
Frontend
- Install Node.js 22.x
- Install
pnpmwithnpm install -g pnpm - Install frontend dependencies with
pnpm install - Start the frontend server with
./run.sh
Backend
-
- Install Python 3.12 (
pyenv install 3.12)
- Install Python 3.12 (
-
Install
poetry- Requires
pipx, see here - Install with
pipx install poetry
- Requires
-
Install backend dependencies with
poetry install. -
Start the backend server with
./run.sh
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 (
/backendand/frontend). ./run.shwill 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.
- Each terminal must start in the respective directory (
Description
Languages
Python
58.3%
TypeScript
33.8%
CSS
2.8%
JavaScript
2.6%
Shell
2.1%
Other
0.4%