Removed cleanliness warning.

This commit is contained in:
Marcus Scholz 2020-07-29 15:25:35 +02:00
parent b3f271e2e9
commit ec308a7428

View File

@ -1,23 +1,15 @@
# lostplaces-backend
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.
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,
datalmodel(s) nor features are finalized yet.
The software ist currently in early development status, neither scope, 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.
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.
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 (pipenv) virtual environment for development
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.