diff --git a/Readme.md b/Readme.md index a3bf0a3..8157246 100644 --- a/Readme.md +++ b/Readme.md @@ -1,32 +1,44 @@ # lostplaces-backend -lostplaces-backend is a Django based Webproject. It once wants to become a +lostplaces-backend is a django based Webproject. It once wants to become a software which allows a group of urban explorers to manage, document and share the locations of lost places while not exposing too much / any information to the public. The software ist currently in early development status, neither scope, -datalayout nor features are finalized yet. +datalmodel(s) nor features are finalized yet. ## Dependencies Right now it depends on the following non-core Python 3 libraries. These can be installed using the package manager of your distribution or into the venv locally. - * [django](https://www.djangoproject.com/) Django is a high-level Python Web framework that encourages rapid development and clean, pragmatic design. - * [django-thumbs-v2](https://github.com/rrmerugu/django-thumbs-v2) Create thumbnails for your images with Django. + * [django](https://www.djangoproject.com/) django is a high-level Python Web framework that encourages rapid development and clean, pragmatic design. + * [django-thumbs-v2](https://github.com/rrmerugu/django-thumbs-v2) Create thumbnails for your images with django. Currently the the repo is quite a mess, with full Python 3.8 site-packages in-repo and other sketchy stuff. This will be fixed sometime. -### Setting up a virtual environment for development +### Setting up a (pipenv) virtual environment for development -source bin/activate (there are several venv definitions for different shells) -source/lostplaces/manage.py migrate -source/lostplaces/manage.py createsuperuser -source/lostplaces/manage.py runserver +After having obtained the repository contents (either via .zip download or git clone), you can easily setup a pipenv virtual environment. The repo provides a Pipfile for easy dependency management that does not mess with your system. + +``` +$ cd lostplaces-backend +$ pipenv install +$ pipenv shell +(lostplaces-backend) $ lostplaces/manage.py migrate +(lostplaces-backend) $ lostplaces/manage.py createsuperuser +(lostplaces-backend) $ lostplaces/manage.py runserver +``` + +### Returning to the venv +``` +$ cd lostplaces-backend +$ pipenv shell +(lostplaces-backend) $ lostplaces/manage.py runserver +``` Visit: [admin](http://localhost:8000/admin) for administrative backend or [frontend](http://localhost:8000/) -### Install django system-wide (as user) -pip3 install --user django +Happy developing ;-)