From fd5a5125d3795574373737660c22f7121667ba91 Mon Sep 17 00:00:00 2001 From: Xevion Date: Tue, 15 Oct 2024 23:05:22 -0500 Subject: [PATCH] begin documenting setup process --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 0be2fa5..b4c97b7 100644 --- a/README.md +++ b/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 \ No newline at end of file