-
Notifications
You must be signed in to change notification settings - Fork 285
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve documentation slightly for new developers
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
1 parent
ebb54ac
commit ba5712f
Showing
2 changed files
with
7 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,8 +35,9 @@ test: check-venv ## Run the test suite | |
|
||
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 reset # Generate test data. | ||
$(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')" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,24 +6,14 @@ 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 | ||
## Running the test project (See the [Makefile](../Makefile) for more details) | ||
|
||
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 | ||
make test_app | ||
|
||
## Running the tests | ||
Tests are run via github actions on any pull request into `master`, and are written for use with the [pytest](https://docs.pytest.org/en/latest/) | ||
|