Geoffrey-Django/GeoffreyApp/docs/source/getting_started.rst

84 lines
1.5 KiB
ReStructuredText

.. _getting_started:
.. |br| raw:: html
<br>
***************
Getting Started
***************
Requirements
#############
Versions shown have been tested to work
* `Python 3.6.6`_
* `Django 2.1.2`_
* `Requests 2.20.0`_
* `simplejson 3.16.0`_
.. _Python 3.6.6: https://www.python.org/
.. _Django 2.1.2: https://pypi.org/project/Django/
.. _Requests 2.20.0: https://pypi.org/project/requests2/
.. _simplejson 3.16.0: https://pypi.org/project/simplejson/
Setup
#####
.. Note:: Geoffrey is a Django application. To install Geoffrey, you need to have a Django site already setup instructions to do that can be found `here`_
.. _here: https://docs.djangoproject.com/en/2.2/intro/tutorial01/
Installing GeoffreyApp From Source
**********************************
1. Download Geoffrey by cloning it
::
git clone https://git.etztech.xyz/ZeroHD/Geoffrey.git GeoffreyApp
2. Change directories into GeoffreyApp
3. Package Geoffrey
::
python setup.py sdist
4. Install Geoffrey as a module
::
pip3 install dist/GeoffreyApp-2.0.tar.gz
Integrate Geoffrey Into The Django Project
******************************************
In ``settings.py`` add ``GeoffreyApp`` to ``INSTALLED_APPS``
Once installed, run the migrations to setup the database for the first time
::
python manage.py makemigrations
python manage.py migrate
Then add the URLs to your projects's ``urls.py``
::
path('GeoffreyApp/', include('GeoffreyApp.urls')),
Setup Settings
**************
To setup your ``settings.py`` for Geoffrey, checkout :ref:`django_settings`