Django Cookie-Cutter - Material Dashboard

Hello! This article explains how to generate a simple Django Dashboard using CookieCutter, a well-known command-line utility that creates projects from project templates. Β The customization process allows choosing the design, database type, and other related information like project name, version and support email (if any). Β For newcomers, Django is a leading web framework created and actively supported by experienced developers using a batteries-included concept. Thanks for reading!


✨ How it Works

To start fast and generate a new project the workstation should have a minimal toolchain used by the generator: Python3, GIT, and (optional) a modern code editor like VsCode or Atom.

πŸ‘‰ Step #1 - Create a virtual environment for dependencies

$ virtualenv env
$ source env/bin/activate
Django Cookie-Cutter - Create VENV

πŸ‘‰ Step #2 - Install Modules

$ pip install cookiecutter
$ pip install GitPython 
Django Cookie-Cutter - Install Modules

πŸ‘‰ Step #3 - Β Generate the project

$ cookiecutter https://github.com/app-generator/cookiecutter-django.git
Django Cookie-Cutter - Generate Project
>>> project_name [Django Seed project]: Django Material
>>> project_slug [django_material]:
>>> description [A simple Django project]:
>>> author_name [AppSeed]:
>>> domain_name [example.com]:
>>> email [appseed@example.com]:
>>> version [0.0.1]:
>>> Select theme:
1 - volt
2 - soft-ui
3 - datta-able
4 - material-dashboard
Choose from 1, 2, 3, 4 [1]: 4       <---- SELECT the Material Design
>>> Select database:
1 - sqlite3
2 - mysql
3 - postgresql
Choose from 1, 2, 3 [1]:
>>> database_name [appseed_django]:
>>> database_user [appseed_user]:
>>> database_pass [Pass1234]:
>>> PRE Gen hook executed
 Cloning theme: <material-dashboard>, REPO: https://github.com/app-generator/django-dashboard-material.git
 ...done
>>> POST Gen hook executed
 *** Copy assets
 ...done
 *** Copy templates
 ...done
Django Cookie-Cutter - Console Output

Once the process is finished, we can change the directory inside the generated sources and use Docker to start the app:

$ cd django_material
$ docker-compose up --build
Django Cookie-Cutter - Start in Docker

At this point, the app should be accessible in the browser at the address http://localhost:85.

Django Cookie-Cutter Material - Login Page
✨ Django Cookie-Cutter - Dashboard Page
Django Cookie-Cutter Material - Dashboard Page
✨ Django Cookie-Cutter - VR page
Django Cookie-Cutter Material - VR Page

Thanks for reading! For more resources please access: