Skip to content

Commit bf64138

Browse files
authored
docs: Updated backend contributing docs (#729)
1 parent 6716241 commit bf64138

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/docs/reference/contributing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ The `description` is a descriptive summary of the change the PR will make.
3636
- Run app: `flutter run`
3737

3838
=== "Backend"
39-
- Install Python 3.12+ and [UV](https://docs.astral.sh/uv/getting-started/)
40-
- Go to `./backend`
41-
- Install dependencies `uv sync`
42-
- Install the pre-commit hooks `uv pre-commit install`
39+
- If you haven't already, switch to the backend folder `cd backend`
40+
- Install dependencies with `uv sync`
41+
- Install the pre-commit hooks `uv run pre-commit install`
4342
- Optionally: Activate your python environment `source .venv/bin/activate` (allows you to omit `uv run` in the following steps, environment can be deactivated with `deactivate`)
44-
- Initialize/Upgrade requirements for the recipe scraper `uv run python -c "import nltk; nltk.download('averaged_perceptron_tagger_eng', download_dir='./venv/nltk_data')"`
43+
- Initialize/Upgrade requirements for the recipe scraper `uv run python -c "import nltk; nltk.download('averaged_perceptron_tagger_eng', download_dir='.venv/nltk_data')"`
4544
- Initialize/Upgrade the SQLite database with `uv run flask db upgrade`
4645
- Run debug server with `uv run wsgi.py`
4746
- The backend should be reachable at `localhost:5000`
47+
- For some simple interactions with the backend (like adding a user), you can use `uv run manage.py`
4848

4949
!!! danger Known Warnings
5050
Do not run the backend using `flask` as it won't initialize the sockets properly.

0 commit comments

Comments
 (0)