Include example project

This commit is contained in:
Sebastien Corbin
2020-04-18 20:20:26 +02:00
parent ac8c20abb3
commit a6946d160d
10 changed files with 148 additions and 3 deletions

View File

@@ -35,8 +35,8 @@ USAGE
# settings.py
INSTALLED_APPS = (
...
'jsignature',
...
'jsignature',
)
* Use provided form field and widget:
@@ -121,7 +121,7 @@ Available settings are:
IN YOUR MODELS
==================
If you wan to store signatures, provided mixin gives a ``signature`` and a ``signature_date`` that update themselves:
If you want to store signatures, provided mixin gives a ``signature`` and a ``signature_date`` that update themselves:
::
@@ -132,11 +132,34 @@ If you wan to store signatures, provided mixin gives a ``signature`` and a ``sig
name = models.CharField()
==================
Example project
==================
If you want to have a demo of this package, just use the example project:
::
git clone https://github.com/fle/django-jsignature.git
cd django-jsignature
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -e .
cd example_project
./manage.py migrate
./manage.py createsuperuser
Fill the user info, launch django with ``./manage.py runserver`` and head over to
`http://127.0.0.1:8000/ <http://127.0.0.1:8000/>`_ and login with the
credentials your provided.
==================
AUTHORS
==================
* Florent Lebreton <florent.lebreton@makina-corpus.com>
* Sébastien Corbin <sebastien.corbin@makina-corpus.com>
|makinacom|_