mirror of
https://github.com/Xevion/linkpulse.git
synced 2025-12-09 18:07:36 -06:00
Separate into /backend and /frontend folders
This commit is contained in:
18
README.md
18
README.md
@@ -4,6 +4,11 @@ This is an empty project right now. It merely holds a simplistic FastAPI server
|
||||
|
||||
- Windows WSL is recommended for development. See [here][wsl] for setup instructions.
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `/backend` A backend server using [FastAPI][fastapi], managed with [Poetry][poetry].
|
||||
- `/frontend` A frontend server using [React][react], managed with [pnpm][pnpm].
|
||||
|
||||
## Setup
|
||||
|
||||
1. Install [`pyenv`][pyenv] or [`pyenv-win`][pyenv-win]
|
||||
@@ -15,9 +20,20 @@ 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 - `poetry install`
|
||||
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.
|
||||
|
||||
|
||||
[fastapi]: https://fastapi.tiangolo.com/
|
||||
[poetry]: https://python-poetry.org/
|
||||
[react]: https://react.dev/
|
||||
[pnpm]: https://pnpm.io/
|
||||
[wsl]: https://docs.microsoft.com/en-us/windows/wsl/install
|
||||
[pipx]: https://pipx.pypa.io/stable/installation/
|
||||
[pyenv]: https://github.com/pyenv/pyenv
|
||||
|
||||
Reference in New Issue
Block a user