Skip to content

Commit

Permalink
docs: reorganize next steps and dependencies sections + fix typos (#426)
Browse files Browse the repository at this point in the history
Small change but useful:
Before the next steps came after the dependencies so while going through
the first setup, one might miss the next steps, stopping at the
dependency update.
Now the sections follow the practical steps one would follow.

Also a couple of small typos fixed.
  • Loading branch information
hillairet authored Dec 3, 2024
1 parent d7a731c commit a7e8af6
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions {{cookiecutter.project_slug}}/docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,10 @@ To switch between different Scaf project contexts:
$ make setup # inside the codebase of the project you want to work on
$ tilt up

## Update dependencies

To update the backend app dependencies, you must edit the `backend/requirements/*.in` files.
Once you have made your changes, you need to regenerate the `backend/requirements/*.txt` files using:

$ make compile


## Next steps

Creating a superuser account in the backend is useful so you have access to
Django Admin that will be accesible at [http://localhost:8009/admin](http://localhost:8009/admin)
Django Admin that will be accessible at [http://localhost:8000/admin](http://localhost:8000/admin)

To create a superuser use the following commands:

Expand All @@ -70,3 +62,10 @@ To create a superuser use the following commands:
{% if cookiecutter.create_nextjs_frontend == 'y' %}
This project has a NextJS frontend configured. You can access it at [http://localhost:3000/](http://localhost:3000/).
{% endif %}

## Update dependencies

To update the backend app dependencies, you must edit the `backend/requirements/*.in` files.
Once you have made your changes, you need to regenerate the `backend/requirements/*.txt` files using:

$ make compile

0 comments on commit a7e8af6

Please sign in to comment.