Skip to content

Commit

Permalink
add external packages to dev setup guide
Browse files Browse the repository at this point in the history
  • Loading branch information
felixrindt committed Aug 2, 2023
1 parent c9bd5ca commit 772f51d
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 9 deletions.
10 changes: 10 additions & 0 deletions docs/admin/deployment/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Deploying ephios
================

This section shows how to deploy ephios in a production environment.

.. note:: This page is work in progress. Feel free to contribute. Either way, ephios can be deployed like most django apps.


.. toctree::
:maxdepth: 2
2 changes: 1 addition & 1 deletion docs/admin/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ This section shows how to install and configure ephios.
.. toctree::
:maxdepth: 2

installation/index
deployment/index
additional_features/index
7 changes: 0 additions & 7 deletions docs/admin/installation/index.rst

This file was deleted.

14 changes: 13 additions & 1 deletion docs/development/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,14 @@ Development setup

To set up a development version on your local machine, you need to execute the following steps:

#. Install external packages required for developing ephios

* ``git`` (to check out the repository)
* ``python`` version 3.8 or higher including dev and virtualenv tooling
* ``gettext`` (to compile translations, might also be named ``msgfmt``)

#. Check out the `repository <https://github.com/ephios-dev/ephios>`_ and cd to it
#. Set up a virtualenv for the project with Python >=3.8 and activate it
#. Set up a virtualenv for the project activate it
#. Install poetry (if not already installed): `Installation guide <https://python-poetry.org/docs/#installation>`_
#. Install dependencies with ``poetry install``
#. Create env file with ``cp .env.example .env``
Expand All @@ -28,6 +34,12 @@ To set up a development version on your local machine, you need to execute the f
#. Start the development server with ``python manage.py runserver``
#. Open your web browser, visit ``http://localhost:8000`` and log in with the default credentials (user ``admin@localhost`` and password ``admin``)

If those steps did not work for you, please contact us or open an issue in the GitHub repository.

.. warning::
The default development server is not suitable for production use. It is not secure and not performant.
If you want to run ephios in production, please follow the :doc:`deployment guide </admin/deployment/index>`

Tests
-----

Expand Down

0 comments on commit 772f51d

Please sign in to comment.