Example app

Makefile

@@ -20,6 +20,10 @@ lint:
 docs:
 	hatch run docs:build
 
+.PHONY: example
+example:
+	hatch run example:runserver
+
 .PHONY: porcelain
 porcelain:
 ifeq ($(shell git status --porcelain),)

README.md

@@ -23,7 +23,7 @@
 
 Install using pip.
 
-```shell
+```console
 pip install django-icons
 ```
 
@@ -82,32 +82,32 @@ See "Supported Versions" on <https://www.djangoproject.com/download/>.
 
 To clone the repository and install the requirements for local development:
 
-```shell
+```console
 $ git clone git://github.com/zostera/django-icons.git
 $ cd django-icons
 $ pip install -e .
 $ pip install -U pip -r requirements-dev.txt
 ```
 
-### Running the demo
+## Example app
 
-You can run the example app:
+An example app is provided in the folder `example`. You can run the example app with this command:
 
-```shell
-cd example && run python manage.py runserver
+```console
+make example
 ```
 
 ### Running the tests
 
 The test suite requires [tox](https://tox.readthedocs.io/) to be installed. Run the complete test suite like this:
 
-```shell
+```console
 tox
 ```
 
 Test for the current environment can be run with the Django `manage.py` command.
 
-```shell
+```console
 python manage.py test
 ```
 

example/README.md

@@ -6,7 +6,7 @@ This example project only supports the latest version of Django.
 
 To run the example:
 
-```bash
+```console
 git clone https://github.com/zostera/django-icons.git
 
 cd django-icons/example
@@ -15,4 +15,4 @@ python manage.py migrate
 python manage.py runserver
 ```
 
-Server should be live at http://127.0.0.1:8000/ now.
+Server should be live at http://127.0.0.1:8000/ now.

pyproject.toml

@@ -90,6 +90,18 @@ matrix.django.dependencies = [
   {value = "django @ git+https://github.com/django/django.git", if = ["main"]},
 ]
 
+[tool.hatch.envs.example]
+python = "3.11"
+template = "example"
+dependencies = [
+  "django>=3.2",
+]
+
+[tool.hatch.envs.example.scripts]
+runserver = [
+  "cd example && python manage.py migrate && python manage.py runserver",
+]
+
 [tool.hatch.envs.docs]
 dependencies = [
   "sphinx>=7.0.1",