-
Notifications
You must be signed in to change notification settings - Fork 341
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Adi Chirilov
committed
Jul 30, 2020
1 parent
91842d8
commit f3e4bbe
Showing
303 changed files
with
59,015 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
DEBUG=True | ||
SECRET_KEY=S3cr3t_K#Key | ||
SERVER=material-dashboard-django.creative-tim.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
|
||
# tests and coverage | ||
*.pytest_cache | ||
.coverage | ||
|
||
# database & logs | ||
*.db | ||
*.sqlite3 | ||
*.log | ||
|
||
# venv | ||
env | ||
venv | ||
|
||
# other | ||
.DS_Store | ||
|
||
# javascript | ||
package-lock.json | ||
|
||
staticfiles/* | ||
!staticfiles/.gitkeep | ||
.vscode/symbols.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Change Log | ||
|
||
|
||
## [1.0.0] 2020-07-30 | ||
### Initial Release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
FROM python:3.6 | ||
|
||
ENV FLASK_APP run.py | ||
|
||
COPY manage.py gunicorn-cfg.py requirements.txt .env ./ | ||
COPY app app | ||
COPY authentication authentication | ||
COPY core core | ||
|
||
RUN pip install -r requirements.txt | ||
|
||
RUN python manage.py makemigrations | ||
RUN python manage.py migrate | ||
|
||
EXPOSE 5005 | ||
CMD ["gunicorn", "--config", "gunicorn-cfg.py", "core.wsgi"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2019 - present Creative-Tim / AppSeed.us | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
web: gunicorn core.wsgi --log-file=- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,202 @@ | ||
# material-dashboard-django | ||
# [Material Dashboard Django](https://www.creative-tim.com/product/material-dashboard-django) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/home?status=Material%20Dashboard,%20a%20free%20Material%20Bootstrap%204%20Admin%20Template%20%E2%9D%A4%EF%B8%8F%20https%3A//bit.ly/2Lyat1Y%20%23bootstrap%20%23material%20%23design%20%23developers%20%23freebie%20%20via%20%40CreativeTim) | ||
|
||
![version](https://img.shields.io/badge/version-1.0.0-blue.svg) [![GitHub issues open](https://img.shields.io/github/issues/creativetimofficial/material-dashboard-django.svg?maxAge=2592000)](https://github.com/creativetimofficial/material-dashboard-django/issues?q=is%3Aopen+is%3Aissue) [![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/creativetimofficial/material-dashboard-django.svg?maxAge=2592000)](https://github.com/creativetimofficial/material-dashboard-django/issues?q=is%3Aissue+is%3Aclosed) [![Join the chat at https://gitter.im/NIT-dgp/General](https://badges.gitter.im/NIT-dgp/General.svg)](https://gitter.im/creative-tim-general/Lobby) [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/E4aHAQy) | ||
|
||
![Material Dashboard Django - Admin Dashboard coded in Django.](https://github.com/creativetimofficial/material-dashboard-django/blob/master/media/material-dashboard-django-intro.gif) | ||
|
||
<br /> | ||
|
||
> Free product - **Django Dashboard** starter project - Features: | ||
- UI Kit: **Material Dashboard** (Free Version) provided by **[Creative-Tim](https://www.creative-tim.com/)** | ||
- [Codebase](https://github.com/app-generator/boilerplate-code-django-dashboard) version v1.0.2 - provided by **[AppSeed](https://appseed.us/)** | ||
- UI-Ready app, SQLite Database, Django Native ORM | ||
- Modular design, clean code-base | ||
- Session-Based Authentication, Forms validation | ||
- Deployment scripts: Docker, Gunicorn / Nginx | ||
|
||
<br /> | ||
|
||
## Table of Contents | ||
|
||
* [Demo](#demo) | ||
* [Quick Start](#quick-start) | ||
* [Documentation](#documentation) | ||
* [File Structure](#file-structure) | ||
* [Browser Support](#browser-support) | ||
* [Resources](#resources) | ||
* [Reporting Issues](#reporting-issues) | ||
* [Technical Support or Questions](#technical-support-or-questions) | ||
* [Licensing](#licensing) | ||
* [Useful Links](#useful-links) | ||
|
||
<br /> | ||
|
||
## Demo | ||
|
||
> To authenticate use the default credentials ***test / ApS12_ZZs8*** or create a new user on the [registration page](https://creativetim-django-dashboard-black-pro.appseed.us/register/). | ||
- **Material Dashboard Django** [Login Page](https://www.creative-tim.com/live/material-dashboard-django) | ||
|
||
<br /> | ||
|
||
## Quick start | ||
|
||
> UNZIP the sources or clone the private repository. After getting the code, open a terminal and navigate to the working directory, with product source code. | ||
```bash | ||
$ # Get the code | ||
$ git clone https://github.com/creativetimofficial/material-dashboard-django.git | ||
$ cd material-dashboard-django | ||
$ | ||
$ # Virtualenv modules installation (Unix based systems) | ||
$ virtualenv env | ||
$ source env/bin/activate | ||
$ | ||
$ # Virtualenv modules installation (Windows based systems) | ||
$ # virtualenv env | ||
$ # .\env\Scripts\activate | ||
$ | ||
$ # Install modules - SQLite Storage | ||
$ pip3 install -r requirements.txt | ||
$ | ||
$ # Create tables | ||
$ python manage.py makemigrations | ||
$ python manage.py migrate | ||
$ | ||
$ # Start the application (development mode) | ||
$ python manage.py runserver # default port 8000 | ||
$ | ||
$ # Start the app - custom port | ||
$ # python manage.py runserver 0.0.0.0:<your_port> | ||
$ | ||
$ # Access the web app in browser: http://127.0.0.1:8000/ | ||
``` | ||
|
||
> Note: To use the app, please access the registration page and create a new user. After authentication, the app will unlock the private pages. | ||
<br /> | ||
|
||
## Documentation | ||
The documentation for the **Material Dashboard Django** is hosted at our [website](https://demos.creative-tim.com/material-dashboard-django/docs/1.0/getting-started/getting-started-django.html). | ||
|
||
<br /> | ||
|
||
## File Structure | ||
Within the download you'll find the following directories and files: | ||
|
||
```bash | ||
< PROJECT ROOT > | ||
| | ||
|-- core/ # Implements app logic and serve the static assets | ||
| |-- settings.py # Django app bootstrapper | ||
| |-- wsgi.py # Start the app in production | ||
| |-- urls.py # Define URLs served by all apps/nodes | ||
| | | ||
| |-- static/ | ||
| | |-- <css, JS, images> # CSS files, Javascripts files | ||
| | | ||
| |-- templates/ # Templates used to render pages | ||
| | | ||
| |-- includes/ # HTML chunks and components | ||
| | |-- navigation.html # Top menu component | ||
| | |-- sidebar.html # Sidebar component | ||
| | |-- footer.html # App Footer | ||
| | |-- scripts.html # Scripts common to all pages | ||
| | | ||
| |-- layouts/ # Master pages | ||
| | |-- base-fullscreen.html # Used by Authentication pages | ||
| | |-- base.html # Used by common pages | ||
| | | ||
| |-- accounts/ # Authentication pages | ||
| | |-- login.html # Login page | ||
| | |-- register.html # Register page | ||
| | | ||
| index.html # The default page | ||
| page-404.html # Error 404 page | ||
| page-500.html # Error 404 page | ||
| *.html # All other HTML pages | ||
| | ||
|-- authentication/ # Handles auth routes (login and register) | ||
| | | ||
| |-- urls.py # Define authentication routes | ||
| |-- views.py # Handles login and registration | ||
| |-- forms.py # Define auth forms | ||
| | ||
|-- app/ # A simple app that serve HTML files | ||
| | | ||
| |-- views.py # Serve HTML pages for authenticated users | ||
| |-- urls.py # Define some super simple routes | ||
| | ||
|-- requirements.txt # Development modules - SQLite storage | ||
| | ||
|-- .env # Inject Configuration via Environment | ||
|-- manage.py # Start the app - Django default start script | ||
| | ||
|-- ************************************************************************ | ||
``` | ||
|
||
<br /> | ||
|
||
## Browser Support | ||
|
||
At present, we officially aim to support the last two versions of the following browsers: | ||
|
||
<img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/chrome.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/firefox.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/edge.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/safari.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/opera.png" width="64" height="64"> | ||
|
||
<br /> | ||
|
||
## Resources | ||
|
||
- Demo: <https://www.creative-tim.com/live/material-dashboard-django> | ||
- Download Page: <https://www.creative-tim.com/product/material-dashboard-django> | ||
- Documentation: <https://demos.creative-tim.com/material-dashboard-django/docs/1.0/getting-started/getting-started-django.html> | ||
- License Agreement: <https://www.creative-tim.com/license> | ||
- Support: <https://www.creative-tim.com/contact-us> | ||
- Issues: [Github Issues Page](https://github.com/creativetimofficial/material-dashboard-django/issues) | ||
|
||
<br /> | ||
|
||
## Reporting Issues | ||
|
||
We use GitHub Issues as the official bug tracker for the **Material Dashboard Django**. Here are some advices for our users that want to report an issue: | ||
|
||
1. Make sure that you are using the latest version of the **Material Dashboard Django**. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/). | ||
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed. | ||
3. Some issues may be browser-specific, so specifying in what browser you encountered the issue might help. | ||
|
||
<br /> | ||
|
||
## Technical Support or Questions | ||
|
||
If you have questions or need help integrating the product please [contact us](https://www.creative-tim.com/contact-us) instead of opening an issue. | ||
|
||
<br /> | ||
|
||
## Licensing | ||
|
||
- Copyright 2019 - present [Creative Tim](https://www.creative-tim.com/) | ||
- Licensed under [Creative Tim EULA](https://www.creative-tim.com/license) | ||
|
||
<br /> | ||
|
||
## Useful Links | ||
|
||
- [More products](https://www.creative-tim.com/bootstrap-themes) from Creative Tim | ||
- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w) | ||
- [Freebies](https://www.creative-tim.com/bootstrap-themes/free) from Creative Tim | ||
- [Affiliate Program](https://www.creative-tim.com/affiliates/new) (earn money) | ||
|
||
<br /> | ||
|
||
## Social Media | ||
|
||
- Twitter: <https://twitter.com/CreativeTim> | ||
- Facebook: <https://www.facebook.com/CreativeTim> | ||
- Dribbble: <https://dribbble.com/creativetim> | ||
- Instagram: <https://www.instagram.com/CreativeTimOfficial> | ||
|
||
<br /> | ||
|
||
--- | ||
[Material Dashboard Django](https://www.creative-tim.com/product/material-dashboard-django) - Provided by [Creative Tim](https://www.creative-tim.com/) and [AppSeed](https://appseed.us) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" | ||
|
||
from django.contrib import admin | ||
|
||
# Register your models here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" | ||
|
||
from django.apps import AppConfig | ||
|
||
class MyConfig(AppConfig): | ||
name = 'cfg' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" | ||
|
||
from django.db import models | ||
from django.contrib.auth.models import User | ||
|
||
# Create your models here. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" | ||
|
||
from django.test import TestCase | ||
|
||
# Create your tests here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" | ||
|
||
from django.urls import path, re_path | ||
from app import views | ||
|
||
urlpatterns = [ | ||
|
||
# The home page | ||
path('', views.index, name='home'), | ||
|
||
# Matches any html file | ||
re_path(r'^.*\.*', views.pages, name='pages'), | ||
|
||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" | ||
|
||
from django.contrib.auth.decorators import login_required | ||
from django.shortcuts import render, get_object_or_404, redirect | ||
from django.template import loader | ||
from django.http import HttpResponse | ||
from django import template | ||
|
||
@login_required(login_url="/login/") | ||
def index(request): | ||
return render(request, "index.html") | ||
|
||
@login_required(login_url="/login/") | ||
def pages(request): | ||
context = {} | ||
# All resource paths end in .html. | ||
# Pick out the html file name from the url. And load that template. | ||
try: | ||
|
||
load_template = request.path.split('/')[-1] | ||
html_template = loader.get_template( load_template ) | ||
return HttpResponse(html_template.render(context, request)) | ||
|
||
except template.TemplateDoesNotExist: | ||
|
||
html_template = loader.get_template( 'page-404.html' ) | ||
return HttpResponse(html_template.render(context, request)) | ||
|
||
except: | ||
|
||
html_template = loader.get_template( 'page-500.html' ) | ||
return HttpResponse(html_template.render(context, request)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# -*- encoding: utf-8 -*- | ||
""" | ||
Copyright (c) 2019 - present AppSeed.us | ||
""" | ||
|
||
from django.contrib import admin | ||
|
||
# Register your models here. |
Oops, something went wrong.