Installation

Clone and go into the cloned directory

git clone https://github.com/FSTUM/template_project.git
cd template_project

Install system dependencies

sudo apt-get update
sudo apt-get install -y python3-pip python3-venv
#sudo apt-get install -y texlive-base texlive-lang-german texlive-fonts-recommended texlive-latex-extra

Install python-dependencies in an virtual environment

python3 -m venv venv
source venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install -r requirements.txt

Development

Install additional dependencies after you installed the dependencies listed in Installation

sudo apt-get install -y gettext npm
python3 -m pip install -r requirements_dev.txt

Create the SQLite-database by running the following command inside the project directory:

python3 manage.py migrate

Create an admin-account by running the following command inside the project directory:

python3 manage.py createsuperuser

Note that this doesn't set the fist_name, thus the username is shown on the website. If you want your fist_name to be shown instead, you have to add your fist name in the admin interface.

Start the local webserver

python3 manage.py runserver

You can now visist http://localhost:8000/ in your browser

pre-commit

Code quality is ensured via various tools bundled in pre-commit.

You can install pre-commit, so it will automatically run on every commit:

pre-commit install

This will check all files modified by your commit and will prevent the commit if a hook fails. To check all files, you can run

pre-commit run --all-files

This will also be run by CI if you push to the repository.

Sample-Data/ "Fixtures"

you can generate example-data (overrides every model with data that looks partially plausible, but is clearly not production-data) by opening the django shell using:

python3 manage.py shell

In the shell type

import common.fixture as fixture
fixture.showroom_fixture_state()

This operation might take a few seconds. Don't worry.

Adding Depenencies

If you want to add a dependency that is in pip add it to the appropriate requirements-file.
If you want to add a dependency that is in npm run npm i DEPENDENCY. Make shure that you do only commit the nessesary files to git.

Staging

An staging environment is offered at template_url.frank.elsinga.de The username is password The password is username

Building and running the dockerfile for local developement

you need to save your enveronmment variables in an .env-file. The further guide assumes content simmilar to the following in staging/.env.

DJANGO_DEBUG="True"
DJANGO_SECRET_KEY="CHOOSE_A_SAVE_PASSWORD"
DJANGO_ALLOWED_HOSTS="0.0.0.0,localhost,127.0.0.1"

Build the dockerfile

docker build -t template_project-staging:v1 .

Run the Dockerfile

docker run --env-file staging/.env -p 8080:8000 template_project-staging:v1

The Staging instance is now availibe at 127.0.0.1:8080 and is pushed to the Github Container Registry for convinience.