Commander1024/lostplaces-backend
Commander1024/lostplaces-backend
1
0
Fork 0
Code Issues 14 Pull Requests Releases Wiki Activity

Updated Readme according to change of name and user model.

Browse Source
This commit is contained in:
Marcus Scholz 2020-09-14 17:37:21 +02:00
parent 547179b0ca
commit c8b3cff5a6
1 changed files with 15 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
Readme.md
View File

@ -34,10 +34,10 @@ After having obtained the repository contents (either via .zip download or git c
$ cd lostplaces-backend $ cd lostplaces-backend
$ pipenv install $ pipenv install
$ pipenv shell $ pipenv shell
(lostplaces-backend) $ lostplaces/manage.py makemigrations (lostplaces-backend) $ django_lostplaces/manage.py makemigrations
(lostplaces-backend) $ lostplaces/manage.py migrate (lostplaces-backend) $ django_lostplaces/manage.py migrate
(lostplaces-backend) $ lostplaces/manage.py createsuperuser (lostplaces-backend) $ django_lostplaces/manage.py createsuperuser
(lostplaces-backend) $ lostplaces/manage.py runserver --ipv6 (lostplaces-backend) $ django_lostplaces/manage.py runserver --ipv6
``` ```
## Returning to the venv ## Returning to the venv
@ -45,9 +45,9 @@ $ pipenv shell
$ cd lostplaces-backend $ cd lostplaces-backend
$ pipenv shell $ pipenv shell
(lostplaces-backend) $ pipenv update # If dependencies changed, or updates available (lostplaces-backend) $ pipenv update # If dependencies changed, or updates available
(lostplaces-backend) $ lostplaces/manage.py makemigrations # If datamodels changed (lostplaces-backend) $ django_lostplaces/manage.py makemigrations # If datamodels changed
(lostplaces-backend) $ lostplaces/manage.py migrate # If datamodels changed (lostplaces-backend) $ django_lostplaces/manage.py migrate # If datamodels changed
(lostplaces-backend) $ lostplaces/manage.py runserver --ipv6 (lostplaces-backend) $ django_lostplaces/manage.py runserver --ipv6
``` ```
Visit: [admin](http://localhost:8000/admin) for administrative backend or Visit: [admin](http://localhost:8000/admin) for administrative backend or
@ -72,12 +72,12 @@ Before making the django instance public, you should tweak the config `settings.
2. Turn off debug mode by setting `DEBUG = False`. 2. Turn off debug mode by setting `DEBUG = False`.
3. Tune the localization settings, see [django's documentation](https://docs.djangoproject.com/en/3.1/topics/i18n/). 3. Tune the localization settings, see [django's documentation](https://docs.djangoproject.com/en/3.1/topics/i18n/).
Run `lostplaces/managy.py collectstatic` and you should be ready to go. Run `django_lostplaces/managy.py collectstatic` and you should be ready to go.
## Installing lostplaces to an existing django instance ## Installing lostplaces to an existing django instance
### Installing django and the lostplaces app ### Installing django and the django_lostplaces app
If you haven't already setup a django instance, see [django's documentation](https://docs.djangoproject.com/en/3.1/topics/install/). If you haven't already setup a django instance, see [django's documentation](https://docs.djangoproject.com/en/3.1/topics/install/).
@ -93,7 +93,7 @@ Now configure your `settings.py` as follows:
```python ```python
INSTALLED_APPS = [ INSTALLED_APPS = [
... ...
'lostplaces', 'django_lostplaces',
'easy_thumbnails', 'easy_thumbnails',
'widget_tweaks', 'widget_tweaks',
'django_taggit' 'django_taggit'
@ -110,18 +110,12 @@ MEDIA_URL = '/uploads/'
MEDIA_ROOT = os.path.join(BASE_DIR, 'uploads') MEDIA_ROOT = os.path.join(BASE_DIR, 'uploads')
``` ```
3. Set the user model (this will be changed in the next release): 3. Set the URL's for login, for example:
```python
AUTH_USER_MODEL = 'lostplaces.Explorer'
```
4. Set the URL's for login, for example:
```python ```python
LOGIN_URL = reverse_lazy('login') LOGIN_URL = reverse_lazy('login')
LOGIN_REDIRECT_URL = reverse_lazy('lostplaces_home') LOGIN_REDIRECT_URL = reverse_lazy('django_lostplaces_home')
LOGOUT_REDIRECT_URL = reverse_lazy('lostplaces_home') LOGOUT_REDIRECT_URL = reverse_lazy('django_lostplaces_home')
``` ```
### Configuring the URL's ### Configuring the URL's
@ -131,7 +125,7 @@ urlpatterns = [
path('admin/', admin.site.urls), path('admin/', admin.site.urls),
path('signup/', SignUpView.as_view(), name='signup'), # If you want to use lostplaces' sign up view. path('signup/', SignUpView.as_view(), name='signup'), # If you want to use lostplaces' sign up view.
path('explorers/', include('django.contrib.auth.urls')), # You can change the 'explorers/' to whatever you desire. path('explorers/', include('django.contrib.auth.urls')), # You can change the 'explorers/' to whatever you desire.
path('', include('lostplaces.urls')), # In this configuration lostplaces will be at the top level of you website, change '' to 'lostplaces/', if you don't want this. path('', include('django_lostplaces.urls')), # In this configuration django_lostplaces will be at the top level of you website, change '' to 'django_lostplaces/', if you don't want this.
] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) # So django can deliver user uploaded files. ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) # So django can deliver user uploaded files.
``` ```
@ -140,4 +134,4 @@ Before making the django instance public, you should tweak the config `settings.
2. Turn off debug mode by setting `DEBUG = False`. 2. Turn off debug mode by setting `DEBUG = False`.
3. Tune the localization settings, see [django's documentation](https://docs.djangoproject.com/en/3.1/topics/i18n/). 3. Tune the localization settings, see [django's documentation](https://docs.djangoproject.com/en/3.1/topics/i18n/).
Run `lostplaces/managy.py collectstatic` you should be ready to go. Run `django_lostplaces/managy.py collectstatic` you should be ready to go.