Skip to content

Commit

Permalink
Improve documentation slightly for new developers
Browse files Browse the repository at this point in the history
The documentation was really easy to follow, but noticed that these comamnds for setting up the test app was already defined in the Makefile, so just repointed the development documentation to use the Make command instead.
  • Loading branch information
PacificGilly committed Aug 28, 2024
1 parent d44a13f commit 913e795
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 17 deletions.
8 changes: 6 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,14 @@ test: check-venv ## Run the test suite
@printf "$(CYAN)Running test suite$(COFF)\n"
$(environment) pytest

reset_app: check-venv ## Reset the DB for a fresh install.
@printf "$(CYAN)Resetting the local DB$(COFF)\n"
$(environment) python tests/test_app/manage.py reset

test_app: check-venv ## Run the test app
@printf "$(CYAN)Running test app$(COFF)\n"
$(environment) python tests/test_app/manage.py migrate
$(environment) python tests/test_app/manage.py runserver_plus
$(environment) python tests/test_app/manage.py migrate # Setup db tables etc.
$(environment) python tests/test_app/manage.py runserver_plus # Run development server (with werkzeug debugger).

test_user: ## Make the test user
$(environment) python tests/test_app/manage.py shell -c "from django.contrib.auth.models import User; User.objects.create_superuser('[email protected]', password='test')"
21 changes: 6 additions & 15 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,15 @@ This project manages dependencies using [poetry](https://python-poetry.org/)

Ensure you have poetry installed (`pip install poetry`)

Then get setup with `poetry install`
Then get setup with `poetry install` you will need to fork the repo and then clone.

git clone [email protected]:farridav/django-jazzmin.git
git clone [email protected]:{github_username}/django-jazzmin.git
poetry install

## Running the test project

Setup db tables etc.

python tests/test_app/manage.py migrate

Generate test data

python tests/test_app/manage.py reset

Run development server (with werkzeug debugger)

python tests/test_app/manage.py runserver_plus
## Running the test project (See the [Makefile](../Makefile) for more details)

make reset_app
make test_app

## Running the tests

Expand Down

0 comments on commit 913e795

Please sign in to comment.