Skip to content

Commit

Permalink
Add documentation on how to use the sample application
Browse files Browse the repository at this point in the history
  • Loading branch information
rtpg committed Jun 24, 2024
1 parent df934d1 commit 08eb191
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
10 changes: 10 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,16 @@ django-taggit uses `tox <https://tox.readthedocs.io/>`_ to run tests:
tox
Running the sample application
------------------------------

There is a sample application in ``sample_taggit``. You can run it by doing the following:

- Run migrations with ``sample_taggit/manage.py migrate``
- Make yourself a superuser with ``sample_taggit/manage.py createsuperuser`` (this should let you use the admin with ease)
- Launch the sample project itself with ``sample_taggit/manage.py runserver``


Follow style conventions (black, flake8, isort)
-----------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion sample_taggit/templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ <h1>Sample Taggit App</h1>
<li>(No posts yet, go to the admin to create some)</li>
{% endfor %}
</ul>
<a href="/admin">Go to admin and manage more data</a>
<a href="/admin">Manage data in the admin</a>
</body>
</html>

0 comments on commit 08eb191

Please sign in to comment.