From 2aa4b4bd5b5466c0add7ebf3fce7690d7d78c06b Mon Sep 17 00:00:00 2001 From: Commander1024 Date: Mon, 27 Jul 2020 09:56:55 +0200 Subject: [PATCH] Added MIT license and rudimentary Readme.md. --- LICENSE | 7 +++++++ Readme.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 LICENSE create mode 100644 Readme.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b65e448 --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2020 Reverend, Commander1024 + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..4d16f1f --- /dev/null +++ b/Readme.md @@ -0,0 +1,31 @@ +# 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. + +The software ist currently in early development status, neither scope, +datalayout 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. + +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 + +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 + +Visit: [admin](http://localhost:8000/admin) for administrative backend or +[frontend](http://localhost:8000/) + +### Install django system-wide (as user) +pip3 install --user django