Skip to content

Commit ea236b0

Browse files
app-generatorapp-generator
authored
Initial commit
0 parents  commit ea236b0

File tree

318 files changed

+44702
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

318 files changed

+44702
-0
lines changed

‎.gitignore‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
*.pyc
2+
*.DS_Store
3+
*.egg*
4+
/dist/
5+
/.idea
6+
/docs/_build/
7+
/node_modules/
8+
build/
9+
env
10+
/staticfiles/
11+
12+
#src
13+
*.sqlite*
14+
15+
.env
16+
node_modules

‎CHANGELOG.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Change Log
2+
3+
## [1.0.10] 2023-04-22
4+
### Changes
5+
6+
- Bump UI version
7+
- Added Gulp Tooling for SCSS
8+
- Update DOCS (readme)
9+
- `CSS Styling`
10+
11+
## [1.0.9] 2023-02-05
12+
### Changes
13+
14+
- Bump UI: [Material Dashboard](https://github.com/app-generator/django-admin-material-dashboard) `v1.0.9`
15+
- DOCS Update (readme). New sections:
16+
- `How to customize the theme`
17+
- Render deployment
18+
- Configure the project to use `home/templates`
19+
- Added `custom-footer` sample
20+
21+
## [1.0.8] 2023-01-10
22+
### Changes
23+
24+
- Bump Theme Version
25+
- [Django Admin Material](https://github.com/app-generator/django-admin-material-dashboard) `v1.0.8`
26+
27+
## [1.0.7] 2023-01-07
28+
### Changes
29+
30+
- Bump Theme Version
31+
- [Django Admin Material](https://github.com/app-generator/django-admin-material-dashboard) `v1.0.6`
32+
33+
## [1.0.6] 2023-01-07
34+
### Changes
35+
36+
- Move to theme-based pattern
37+
- [Django Admin Material](https://github.com/app-generator/django-admin-material-dashboard)
38+
- 🚀 `Deployment`
39+
- `CI/CD` flow via `Render`
40+
41+
## [1.0.5] 2022-05-30
42+
### Improvements
43+
44+
- Built with [Material Dashboard Generator](https://appseed.us/generator/material-dashboard/)
45+
- Timestamp: `2022-05-30 21:17`
46+
47+
## [1.0.4] 2022-01-16
48+
### Improvements
49+
50+
- Bump Django Codebase to [v2stable.0.1](https://github.com/app-generator/boilerplate-code-django-dashboard/releases)
51+
- Dependencies update (all packages)
52+
- Django==4.0.1
53+
- Settings update for Django 4.x
54+
- `New Parameter`: CSRF_TRUSTED_ORIGINS
55+
- [Origin header checking isn`t performed in older versions](https://docs.djangoproject.com/en/4.0/ref/settings/#csrf-trusted-origins)
56+
57+
## [1.0.3] 2021-10-22
58+
### Improvements
59+
60+
- Bump UI: Material Dashboard - v3.0.0
61+
- Update Bootstrap to v5.1.3
62+
- Update to Material Design 2
63+
64+
## [1.0.2] 2021-09-17
65+
### Improvements
66+
67+
- Bump Django Codebase to [v2.0.4](https://github.com/app-generator/boilerplate-code-django-dashboard/releases)
68+
- Dependencies update (all packages)
69+
- Use Django==3.2.6 (latest stable version)
70+
- Better Code formatting
71+
- Improved Files organization
72+
- Optimize imports
73+
- Docker Scripts Update
74+
- Tooling:
75+
- Gulp SASS compilation script
76+
- `Update README` - Recompile SCSS (new section)
77+
- Fixes:
78+
- Patch 500 Error when authenticated users access `admin` path (no slash at the end)
79+
- Patch [#16](https://github.com/app-generator/boilerplate-code-django-dashboard/issues/16): Minor issue in Docker
80+
81+
## [1.0.1] 2021-01-13
82+
### Bug fixing, Improvements
83+
84+
- Bump UI: [Jinja Material](https://github.com/app-generator/jinja-material-dashboard) v1.0.2
85+
- Bump Codebase: [Django Dashboard](https://github.com/app-generator/boilerplate-code-django-dashboard) v1.0.4
86+
87+
## [1.0.0] 2020-02-07
88+
### Initial Release

‎Dockerfile‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
FROM python:3.9
2+
3+
# set environment variables
4+
ENV PYTHONDONTWRITEBYTECODE 1
5+
ENV PYTHONUNBUFFERED 1
6+
7+
COPY requirements.txt .
8+
# install python dependencies
9+
RUN pip install --upgrade pip
10+
RUN pip install --no-cache-dir -r requirements.txt
11+
12+
COPY . .
13+
14+
# running migrations
15+
RUN python manage.py migrate
16+
17+
# gunicorn
18+
CMD ["gunicorn", "--config", "gunicorn-cfg.py", "core.wsgi"]

‎LICENSE.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# MIT License
2+
3+
Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
4+
5+
<br />
6+
7+
## Licensing Information
8+
9+
<br />
10+
11+
| Item | - |
12+
| ---------------------------------- | --- |
13+
| License Type | MIT |
14+
| Use for print | **YES** |
15+
| Create single personal website/app | **YES** |
16+
| Create single website/app for client | **YES** |
17+
| Create multiple website/apps for clients | **YES** |
18+
| Create multiple SaaS applications | **YES** |
19+
| End-product paying users | **YES** |
20+
| Product sale | **YES** |
21+
| Remove footer credits | **YES** |
22+
| --- | --- |
23+
| Remove copyright mentions from source code | NO |
24+
| Production deployment assistance | NO |
25+
| Create HTML/CSS template for sale | NO |
26+
| Create Theme/Template for CMS for sale | NO |
27+
| Separate sale of our UI Elements | NO |
28+
29+
<br />
30+
31+
---
32+
For more information regarding licensing, please contact the AppSeed Service < *support@appseed.us* >

‎README.md‎

Lines changed: 230 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,230 @@
1+
# [Django Material Dashboard](https://appseed.us/product/material-dashboard/django/)
2+
3+
Open-source **Django** project crafted on top of **[Material Dashboard](https://appseed.us/product/material-dashboard/django/)**, an open-source `Boostrap 5` design from [Creative-Tim](https://www.creative-tim.com/?AFFILIATE=128200)
4+
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. `Material Material` has easy and intuitive responsive design whether it is viewed on retina screens or laptops.
5+
6+
- 👉 [Django Material Dashboard](https://appseed.us/product/material-dashboard/django/) - `Product page`
7+
- 👉 [Django Material Dashboard](https://django-material-dash2.onrender.com) - `LIVE Demo`
8+
- 🛒 **[Django Material Dashboard PRO](https://appseed.us/product/material-dashboard2-pro/django/)** - `Premium Version`
9+
10+
<br />
11+
12+
> Features:
13+
14+
- ✅ `Up-to-date Dependencies`
15+
- ✅ Theme: [Django Admin Material](https://github.com/app-generator/django-admin-material-dashboard), **designed by [Creative-Tim](https://www.creative-tim.com/product/material-dashboard?AFFILIATE=128200)**
16+
- `can be used in any Django project` (new or legacy)
17+
- ✅ **Authentication**: `Django.contrib.AUTH`, Registration
18+
- 🚀 `Deployment`
19+
- `CI/CD` flow via `Render`
20+
21+
<br />
22+
23+
![Material Dashboard - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/169301658-6cf27993-c451-4cd4-9ffa-2968b8981167.png)
24+
25+
<br />
26+
27+
## Manual Build
28+
29+
> 👉 Download the code
30+
31+
```bash
32+
$ git clone https://github.com/app-generator/django-material-dashboard.git
33+
$ cd django-material-dashboard
34+
```
35+
36+
<br />
37+
38+
> 👉 Install modules via `VENV`
39+
40+
```bash
41+
$ virtualenv env
42+
$ source env/bin/activate
43+
$ pip install -r requirements.txt
44+
```
45+
46+
<br />
47+
48+
> 👉 Set Up Database
49+
50+
```bash
51+
$ python manage.py makemigrations
52+
$ python manage.py migrate
53+
```
54+
55+
<br />
56+
57+
> 👉 Create the Superuser
58+
59+
```bash
60+
$ python manage.py createsuperuser
61+
```
62+
63+
<br />
64+
65+
> 👉 Start the app
66+
67+
```bash
68+
$ python manage.py runserver
69+
```
70+
71+
At this point, the app runs at `http://127.0.0.1:8000/`.
72+
73+
<br />
74+
75+
## Codebase structure
76+
77+
The project is coded using a simple and intuitive structure presented below:
78+
79+
```bash
80+
< PROJECT ROOT >
81+
|
82+
|-- core/
83+
| |-- settings.py # Project Configuration
84+
| |-- urls.py # Project Routing
85+
|
86+
|-- home/
87+
| |-- views.py # APP Views
88+
| |-- urls.py # APP Routing
89+
| |-- models.py # APP Models
90+
| |-- tests.py # Tests
91+
| |-- templates/ # Theme Customisation
92+
| |-- includes #
93+
| |-- custom-footer.py # Custom Footer
94+
|
95+
|-- requirements.txt # Project Dependencies
96+
|
97+
|-- env.sample # ENV Configuration (default values)
98+
|-- manage.py # Start the app - Django default start script
99+
|
100+
|-- ************************************************************************
101+
```
102+
103+
<br />
104+
105+
## How to Customize
106+
107+
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.
108+
The theme used to style this starter provides the following files:
109+
110+
```bash
111+
# This exists in ENV: LIB/admin_material
112+
< UI_LIBRARY_ROOT >
113+
|
114+
|-- templates/ # Root Templates Folder
115+
| |
116+
| |-- accounts/
117+
| | |-- login.html # Sign IN Page
118+
| | |-- register.html # Sign UP Page
119+
| |
120+
| |-- includes/
121+
| | |-- footer.html # Footer component
122+
| | |-- sidebar.html # Sidebar component
123+
| | |-- navigation.html # Navigation Bar
124+
| | |-- scripts.html # Scripts Component
125+
| |
126+
| |-- layouts/
127+
| | |-- base.html # Masterpage
128+
| | |-- base-auth.html # Masterpage for Auth Pages
129+
| |
130+
| |-- pages/
131+
| |-- index.html # Dashboard Page
132+
| |-- profile.html # Profile Page
133+
| |-- *.html # All other pages
134+
|
135+
|-- ************************************************************************
136+
```
137+
138+
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.
139+
140+
> For instance, if we want to **customize the footer.html** these are the steps:
141+
142+
- ✅ `Step 1`: create the `templates` DIRECTORY inside the `home` app
143+
- ✅ `Step 2`: configure the project to use this new template directory
144+
- `core/settings.py` TEMPLATES section
145+
- ✅ `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
146+
- Source PATH: `<YOUR_ENV>/LIB/admin_material/template/includes/footer.html`
147+
- Destination PATH: `<PROJECT_ROOT>home/templates/includes/footer.html`
148+
149+
> To speed up all these steps, the **codebase is already configured** (`Steps 1, and 2`) and a `custom footer` can be found at this location:
150+
151+
`home/templates/includes/custom_footer.html`
152+
153+
By default, this file is unused because the `theme` expects `footer.html` (without the `custom-` prefix).
154+
155+
In order to use it, simply rename it to `footer.html`. Like this, the default version shipped in the library is ignored by Django.
156+
157+
In a similar way, all other files and components can be customized easily.
158+
159+
<br />
160+
161+
## CSS Styling
162+
163+
The UI can be customized via the SCSS file. This setup was tested using:
164+
165+
- `Node` v16.15.0
166+
- `Yarn` 1.22.18
167+
- `Gulp` CLI version: `2.3.0`, Local version: `4.0.2`
168+
169+
```bash
170+
$ cd static
171+
$ yarn # Install Modules
172+
$ vi scss/material-dashboard/_variables.scss # Edit primary, secondary colors
173+
$ gulp # Regenerate CSS files
174+
```
175+
176+
> NOTE, once the CSS files are successfully regenerated, force a hard refresh in the browser (Shift + F5 in Chrome).
177+
178+
The relevant lines in `_variables.scss` are highlighted below:
179+
180+
```SCSS
181+
// _variables.scss, LINES 56 -> 63
182+
$primary: #e91e63 !default; // EDIT & Recompile SCSS
183+
$secondary: #7b809a !default; // EDIT & Recompile SCSS
184+
$info: #1A73E8 !default; // EDIT & Recompile SCSS
185+
$success: #4CAF50 !default; // EDIT & Recompile SCSS
186+
$warning: #fb8c00 !default; // EDIT & Recompile SCSS
187+
$danger: #F44335 !default; // EDIT & Recompile SCSS
188+
$light: $gray-200 !default; // EDIT & Recompile SCSS
189+
$dark: $h-color !default; // EDIT & Recompile SCSS
190+
```
191+
192+
<br />
193+
194+
## Deploy on [Render](https://render.com/)
195+
196+
- Create a Blueprint instance
197+
- Go to https://dashboard.render.com/blueprints this link.
198+
- Click `New Blueprint Instance` button.
199+
- Connect your `repo` which you want to deploy.
200+
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
201+
- After that your deployment will start automatically.
202+
203+
At this point, the product should be LIVE.
204+
205+
<br />
206+
207+
## [PRO Version](https://appseed.us/product/material-dashboard2-pro/django/)
208+
209+
This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design inspired by Google's Material Design. `Material Dashboard 2 PRO` is built with over 300 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
210+
211+
> Features:
212+
213+
- ✅ `Up-to-date Dependencies`
214+
- ✅ `Design`: [Django Theme Material2](https://github.com/app-generator/django-admin-material2-pro) - `PRO Version`
215+
- ✅ `Sections` covered by the design:
216+
- ✅ **Admin section** (reserved for superusers)
217+
- ✅ **Authentication**: `Django.contrib.AUTH`, Registration
218+
- ✅ **All Pages** available in for ordinary users
219+
- ✅ `Docker`
220+
- 🚀 `Deployment`
221+
- `CI/CD` flow via `Render`
222+
223+
<br />
224+
225+
![Material Dashboard 2 Pro](https://user-images.githubusercontent.com/51070104/211141418-6b7886eb-6fb3-433e-91c9-2895c086099a.png)
226+
227+
<br />
228+
229+
---
230+
[Django Material Dashboard](https://appseed.us/product/material-dashboard/django/) - Minimal **Django** core provided by **[AppSeed](https://appseed.us/)**

0 commit comments

Comments
 (0)