Repository files navigation

Reference codebase used byAppSeed in all DjangoApps andDashboard starters - the product uses an amazing design crafted byCreative-Tim.

• 👉Django Boilerplate -Product page
• 👉Django Boilerplate -LIVE Demo
• 👉 FreeSupport viaEmail &Discord

Features:

• ✅Up-to-date Dependencies
• ✅ Theme:Django Theme Material Kit,designed byCreative-Tim
• ✅Authentication:Django.contrib.AUTH, Registration
• 🚀Deployment
  • CI/CD flow viaRender

👉Step 1 - Download the code from the GH repository (usingGIT)

$ git clone https://github.com/app-generator/boilerplate-code-django.git$cd boilerplate-code-django

👉Step 2 - Start the APP inDocker

$ docker-compose up --build

Visithttp://localhost:5085 in your browser. The app should be up & running.

👉 Download the code

$ git clone https://github.com/app-generator/boilerplate-code-django.git$cd boilerplate-code-django

👉 Install modules viaVENV

$ virtualenv env$source env/bin/activate$ pip install -r requirements.txt

👉 Set Up Database

$ python manage.py makemigrations$ python manage.py migrate

👉 Create the Superuser

$ python manage.py createsuperuser

👉 Start the app

$ python manage.py runserver

At this point, the app runs athttp://127.0.0.1:8000/.

The project is coded using a simple and intuitive structure presented below:

< PROJECT ROOT>||-- core/||-- settings.py# Project Configuration||-- urls.py# Project Routing||-- home/||-- views.py# APP Views||-- urls.py# APP Routing||-- models.py# APP Models||-- tests.py# Tests||-- templates/# Theme Customisation||-- pages#||-- custom-index.html# Custom Footer||-- requirements.txt# Project Dependencies||-- env.sample# ENV Configuration (default values)|-- manage.py# Start the app - Django default start script||--************************************************************************

When a template file is loaded,Django scans all template directories starting from the ones defined by the user, and returns the first match or an error in case the template is not found.The theme used to style this starter provides the following files:

# This exists in ENV: LIB/theme_material_kit< UI_LIBRARY_ROOT>||-- templates/# Root Templates Folder||||-- accounts/|||-- sign-in.html# Sign IN Page|||-- sign-up.html# Sign UP Page||||-- includes/|||-- footer.html# Footer component|||-- navigation.html# Navigation Bar|||-- scripts.html# Scripts Component||||-- layouts/|||-- base.html# Masterpage||||-- pages/||-- index.html# Dashboard Page||-- author.html# Profile Page||--*.html# All other pages||--************************************************************************

When the project requires customization, we need to copy the original file that needs an update (from the virtual environment) and place it in the template folder using the same path.

For instance, if we want tocustomize the index.html these are the steps:

• ✅Step 1: create thetemplates DIRECTORY inside thehome app
• ✅Step 2: configure the project to use this new template directory
  • core/settings.py TEMPLATES section
• ✅Step 3: copy theindex.html from the original location (inside your ENV) and save it to thehome/templates DIR
  • Source PATH:<YOUR_ENV>/LIB/theme_material_kit/template/pages/index.html
  • Destination PATH:<PROJECT_ROOT>home/templates/pages/index.html

To speed up all these steps, thecodebase is already configured (Steps 1, and 2) and acustom index can be found at this location:

home/templates/pages/custom-index.html

By default, this file is unused because thetheme expectsindex.html (without thecustom- prefix).

In order to use it, simply rename it toindex.html. Like this, the default version shipped in the library is ignored by Django.

In a similar way, all other files and components can be customized easily.

• Create a Blueprint instance
  • Go tohttps://dashboard.render.com/blueprints this link.
• ClickNew Blueprint Instance button.
• Connect yourrepo which you want to deploy.
• Fill theService Group Name and click onUpdate Existing Resources button.
• After that your deployment will start automatically.

At this point, the product should be LIVE.

Django Boilerplate -Django Starter provided byAppSeed