mirror of
https://github.com/Xevion/linkpulse.git
synced 2025-12-06 09:15:32 -06:00
begin documenting setup process
This commit is contained in:
20
README.md
20
README.md
@@ -2,3 +2,23 @@
|
||||
|
||||
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][wsl] for setup instructions.
|
||||
|
||||
## Setup
|
||||
|
||||
1. Install [`pyenv`][pyenv] or [`pyenv-win`][pyenv-win]
|
||||
|
||||
- Install Python 3.12 (`pyenv install 3.12`)
|
||||
|
||||
2. Install `poetry`
|
||||
|
||||
- Requires `pipx`, see [here][pipx]
|
||||
- Install with `pipx install poetry`
|
||||
|
||||
3. Install backend dependencies - `poetry install`
|
||||
|
||||
|
||||
[wsl]: https://docs.microsoft.com/en-us/windows/wsl/install
|
||||
[pipx]: https://pipx.pypa.io/stable/installation/
|
||||
[pyenv]: https://github.com/pyenv/pyenv
|
||||
[pyenv-win]: https://github.com/pyenv-win/pyenv-win
|
||||
Reference in New Issue
Block a user