marekpawlowski / django-helloworld

A Django hello world example

django-helloworld

# Update - new steps -- START

## Installation

To run you need docker and docker-compose installed on your local machine.

## Run - local machine

The makefile has all management configurations to perform actions to run applications locally.

make start - will run docker-compose build, vulnerability scan, and docker-compose start. example: make start TAG=latest ENV=dev The web app will be available under the address http://django.localhost:8008/. Trafik dashboard - http://127.0.0.1:8081/dashboard/#/. make build - will run docker-compose build make stop - will run docker-compose stop make trivy-scan - will run local docker image vulnerability scan

To run it properly you must define in your local machine ENV-s, TAG and ENV. TAG is related to the tag which will be linked to the docker image. example - latest, 1.0.1... ENV is related to which environment you want to deploy. example - prod or dev

## Run - remote

Remote is similar to a local option but in that case, you must change the definition in Trafik for certificates (you can't create certificate via that option for internal domain) in files -> docker-compose-prod.yaml and treafik/treafik.prod.toml

# Update - new steps -- END

A Django 'Hello World' program example.

Installation

You need install the pre-requirements for run this Hello World example.

Update repositories of available packages to install, with the following command:

$ sudo apt update

Install necessary minimum dependencies, with the following command:

$ sudo apt install python3-dev python3-pip python3-virtualenv sqlitebrowser

For run this example need to install Django framework execute the follow command:

$ sudo pip install -r requirements.txt

And later followed by:

$ python3 manage.py migrate

At which point you should see:

Operations to perform:
  Apply all migrations: admin, auth, contenttypes, sessions, sites
Running migrations:

  Applying contenttypes.0001_initial... OK
  Applying auth.0001_initial... OK
  Applying admin.0001_initial... OK
  Applying admin.0002_logentry_remove_auto_add... OK
  Applying admin.0003_logentry_add_action_flag_choices... OK
  Applying contenttypes.0002_remove_content_type_name... OK
  Applying auth.0002_alter_permission_name_max_length... OK
  Applying auth.0003_alter_user_email_max_length... OK
  Applying auth.0004_alter_user_username_opts... OK
  Applying auth.0005_alter_user_last_login_null... OK
  Applying auth.0006_require_contenttypes_0002... OK
  Applying auth.0007_alter_validators_add_error_messages... OK
  Applying auth.0008_alter_user_username_max_length... OK
  Applying auth.0009_alter_user_last_name_max_length... OK
  Applying sessions.0001_initial... OK
  Applying sites.0001_initial... OK
  Applying sites.0002_alter_domain_unique... OK

For use the Django Admin Interface, it's needed to create a superuser for management, with the following command:

$ python3 manage.py createsuperuser --username admin --email [e-mail]

At which point you should see:

Password:
Password (again):

Superuser created successfully.

Run application

After which you can run:

$ python3 manage.py runserver

Then, you can open the URL http://127.0.0.1:8000/ in your web browser and you can see the hello world example like this:

A Django 'Hello World' program example

Also you can open in your web browser the URL http://127.0.0.1:8000/admin for access to the Django Admin Interface like this:

Django Admin Interface running