Django Template is a simple Django app that comes equipped with a landing page, authentication functionality, and a dashboard.
It was designed to save developers time and frustration when creating new Django applications by providing a pre-built foundation with some of the most common features already in place.
This Django template is extremely barebones and comes with three pre-configured apps: landing_page, accounts, and dashboard.
- landing_page - serves as the homepage for your application and can be customized further to fit your needs.
- accounts - adds user registration, login and logout functionality to your application.
- dashboard - the app where your users are directed after login/registration. Your app functionality can be added here.
To begin using this template, start by creating a directory for your project:
mkdir <YOUR_PROJECT_NAME>
cd <YOUR_PROJECT_NAME>
Clone the repository into the current directory:
git clone git@github.com:michael-awe/django-template.git .
Next, create and activate a virtual environment
python3 -m venv env
source env/bin/activate
Now install the dependencies from requirements.txt
pip install -r requirements.txt
After installing the requirements, run setup.sh. When prompted, enter a new project name:
sh setup.sh
...
Enter a new project name: (ensure name is allowed by Django before pressing ENTER)
NOTE: Ensure that the project name you enter is unique to ensure no clashes with Django or other Python modules
After successfully setting up the template, you can use it as a starting point for your Django application.
You can customize the landing page, authentication, and dashboard apps to fit the specific needs of your application. The pre-built foundation provides a solid starting point that you can build on top of, without having to start from scratch.
If you would like to contribute to this repository or notice any issues with the code, please feel free to fork this repository and submit your changes in a pull request. Any contributions that improve the functionality or usability of the project are welcome.
Django Template is licensed under the MIT License, which means that you are free to use, modify, and distribute the project as you see fit. See the LICENSE file for more information.