Skip to content

Commit

Permalink
requirements and Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
morlandi committed Jan 8, 2019
1 parent 84c7664 commit 3cf2120
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 10 deletions.
28 changes: 19 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,39 @@ However, as the project evolves and the frontend improves, the usage of the admi

Adding editing capabilities to the frontend in a modern user interface requires the usage of modal forms, which, to be honest, have always puzzled me for some reason.

This project is not a reusable Django package, but rather a collection of techniques and examples used to cope with modal popups, form submission and validation via ajax, and best practices to organize the code in an effective way to minimize repetitions.
**This project is not a reusable Django package (not yet, at least)**, but rather a collection of techniques and examples used to cope with modal popups, form submission and validation via ajax, and best practices to organize the code in an effective way to minimize repetitions.

Any interest in having these techniques packaged as a reusable Django app ?
If so, please let me know by leaving a comment in the issue tracker.

.. figure:: ./docs/source/_static/images/main_screen.png

Installation
------------

Make a new virtualenv for the project, and run::
Download the project::

$ git clone https://github.com/morlandi/editing-django-models-in-the-frontend.git
$ cd editing-django-models-in-the-frontend

Make a new virtualenv for the project, activate and update it::

pip install -r requirements.txt
$ python3 -m venv ./venv
$ source ./venv/bin/activate
$ pip install -r requirements.txt

build the database::

cd sample_project
python manage.py migrate
$ cd sample_project
$ python manage.py migrate

create a superuser to work with::

python manage.py createsuperuser --username admin
$ python manage.py createsuperuser --username admin

then::

python manage.py runserver
$ python manage.py runserver

and visit the projects at http://127.0.0.1:8000/

Expand All @@ -47,15 +57,15 @@ Project requirements

I happen to use:

- django v2.1.1
- django v2.1.5
- jquery v3.3.1
- jquery-ui v1.12.1 (only required for draggable)
- django-bootstrap3 v11.0.0

but the techniques investigated should be usable in similar contexts.

A full explanation of what is going on under the hood is here:

Documentation, installation and instructions are at
https://editing-django-models-in-the-frontend.readthedocs.io

License
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
django==2.1.1
django==2.1.5
django-bootstrap3==11.0.0

0 comments on commit 3cf2120

Please sign in to comment.