Skip to content

Commit 019999b

Browse files
app-generatorapp-generator
committed
Release v1.0.3
1 parent 98dd8ba commit 019999b

File tree

365 files changed

+58423
-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.

365 files changed

+58423
-0
lines changed

‎.env

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# True for development, False for production
2+
DEBUG=True
3+
4+
# Deployment SERVER address
5+
SERVER=.appseed.us
6+
7+
# Used for CDN (in production)
8+
ASSETS_ROOT=/static/assets # !!! Without Slash at the end !!!

‎.gitignore

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
5+
# tests and coverage
6+
*.pytest_cache
7+
.coverage
8+
9+
# database & logs
10+
*.db
11+
*.sqlite3
12+
*.log
13+
14+
# venv
15+
env
16+
venv
17+
18+
# other
19+
.DS_Store
20+
21+
# javascript
22+
package-lock.json
23+
24+
staticfiles/*
25+
!staticfiles/.gitkeep
26+
.vscode/symbols.json
27+
28+
apps/static/assets/node_modules
29+
apps/static/assets/yarn.lock
30+
apps/static/assets/.temp
31+

‎CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Change Log
22

3+
## [1.0.3] 2022-05-25
4+
### Improvements
5+
6+
- Built with [Material Kit Generator](https://appseed.us/generator/material-kit/)
7+
- Timestamp: `2022-05-25 22:04`
8+
- Codebase refactoring
9+
- Added CDN Support
10+
- via `.env` **ASSETS_ROOT**
11+
312
## [1.0.2] 2021-01-19
413
### Improvements
514

‎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+
COPY . .
4+
5+
# set environment variables
6+
ENV PYTHONDONTWRITEBYTECODE 1
7+
ENV PYTHONUNBUFFERED 1
8+
9+
# install python dependencies
10+
RUN pip install --upgrade pip
11+
RUN pip install --no-cache-dir -r requirements.txt
12+
13+
# running migrations
14+
RUN python manage.py migrate
15+
16+
# gunicorn
17+
CMD ["gunicorn", "--config", "gunicorn-cfg.py", "core.wsgi"]
18+

‎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: 228 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,228 @@
1+
# [Material Kit](https://appseed.us/generator/material-kit/) Django
2+
3+
`Open-Source` seed project generated by AppSeed in **Django** Framework on top of **[Material Kit](https://appseed.us/generator/material-kit/)** design. Designed for those who like bold elements and beautiful websites, **Material Kit 2** is ready to help you create stunning websites and web apps. `Material Kit 2` is built with over 60 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
4+
5+
<br />
6+
7+
> Built with [Material Kit Generator](https://appseed.us/generator/material-kit/)
8+
9+
- Timestamp: `2022-05-25 22:04`
10+
- Build ID: `de50726c-6382-4e2c-98ea-460c0d503809`
11+
- **Free [Support](https://appseed.us/support/)** (registered users) via `Email` and `Discord`
12+
13+
<br />
14+
15+
> Features
16+
17+
- `Up-to-date dependencies`
18+
- Database: `sqlite`
19+
- UI-Ready app, Django Native ORM
20+
- `Session-Based authentication`, Forms validation
21+
22+
<br />
23+
24+
![Material Kit - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/167396765-c88b7a95-155f-4236-8691-7b80fa2d9cd9.png)
25+
26+
<br />
27+
28+
## ✨ Start the app in Docker
29+
30+
> **Step 1** - Download the code from the GH repository (using `GIT`)
31+
32+
```bash
33+
$ # Get the code
34+
$ git clone https://github.com/app-generator/django-material-kit.git
35+
$ cd django-material-kit
36+
```
37+
38+
<br />
39+
40+
> **Step 2** - Edit `.env` and remove or comment all `DB_*` settings (`DB_ENGINE=...`). This will activate the `SQLite` persistance.
41+
42+
```txt
43+
DEBUG=True
44+
45+
# Deployment SERVER address
46+
SERVER=.appseed.us
47+
48+
# For MySql Persistence
49+
# DB_ENGINE=mysql <-- REMOVE or comment for Docker
50+
# DB_NAME=appseed_db <-- REMOVE or comment for Docker
51+
# DB_HOST=localhost <-- REMOVE or comment for Docker
52+
# DB_PORT=3306 <-- REMOVE or comment for Docker
53+
# DB_USERNAME=appseed_db_usr <-- REMOVE or comment for Docker
54+
# DB_PASS=<STRONG_PASS> <-- REMOVE or comment for Docker
55+
56+
```
57+
58+
<br />
59+
60+
> **Step 3** - Start the APP in `Docker`
61+
62+
```bash
63+
$ docker-compose up --build
64+
```
65+
66+
Visit `http://localhost:85` in your browser. The app should be up & running.
67+
68+
<br />
69+
70+
## ✨ How to use it
71+
72+
> Download the code
73+
74+
```bash
75+
$ # Get the code
76+
$ git clone https://github.com/app-generator/django-material-kit.git
77+
$ cd django-material-kit
78+
```
79+
80+
<br />
81+
82+
### 👉 Set Up for `Unix`, `MacOS`
83+
84+
> Install modules via `VENV`
85+
86+
```bash
87+
$ virtualenv env
88+
$ source env/bin/activate
89+
$ pip3 install -r requirements.txt
90+
```
91+
92+
<br />
93+
94+
> Set Up Database
95+
96+
```bash
97+
$ python manage.py makemigrations
98+
$ python manage.py migrate
99+
```
100+
101+
<br />
102+
103+
> Start the app
104+
105+
```bash
106+
$ python manage.py runserver
107+
```
108+
109+
At this point, the app runs at `http://127.0.0.1:8000/`.
110+
111+
<br />
112+
113+
### 👉 Set Up for `Windows`
114+
115+
> Install modules via `VENV` (windows)
116+
117+
```
118+
$ virtualenv env
119+
$ .\env\Scripts\activate
120+
$ pip3 install -r requirements.txt
121+
```
122+
123+
<br />
124+
125+
> Set Up Database
126+
127+
```bash
128+
$ python manage.py makemigrations
129+
$ python manage.py migrate
130+
```
131+
132+
<br />
133+
134+
> Start the app
135+
136+
```bash
137+
$ python manage.py runserver
138+
```
139+
140+
At this point, the app runs at `http://127.0.0.1:8000/`.
141+
142+
<br />
143+
144+
## ✨ Create Users
145+
146+
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
147+
148+
- Start the app via `flask run`
149+
- Access the `registration` page and create a new user:
150+
- `http://127.0.0.1:8000/register/`
151+
- Access the `sign in` page and authenticate
152+
- `http://127.0.0.1:8000/login/`
153+
154+
<br />
155+
156+
## ✨ Code-base structure
157+
158+
The project is coded using a simple and intuitive structure presented below:
159+
160+
```bash
161+
< PROJECT ROOT >
162+
|
163+
|-- core/ # Implements app configuration
164+
| |-- settings.py # Defines Global Settings
165+
| |-- wsgi.py # Start the app in production
166+
| |-- urls.py # Define URLs served by all apps/nodes
167+
|
168+
|-- apps/
169+
| |
170+
| |-- home/ # A simple app that serve HTML files
171+
| | |-- views.py # Serve HTML pages for authenticated users
172+
| | |-- urls.py # Define some super simple routes
173+
| |
174+
| |-- authentication/ # Handles auth routes (login and register)
175+
| | |-- urls.py # Define authentication routes
176+
| | |-- views.py # Handles login and registration
177+
| | |-- forms.py # Define auth forms (login and register)
178+
| |
179+
| |-- static/
180+
| | |-- <css, JS, images> # CSS files, Javascripts files
181+
| |
182+
| |-- templates/ # Templates used to render pages
183+
| |-- includes/ # HTML chunks and components
184+
| | |-- navigation.html # Top menu component
185+
| | |-- sidebar.html # Sidebar component
186+
| | |-- footer.html # App Footer
187+
| | |-- scripts.html # Scripts common to all pages
188+
| |
189+
| |-- layouts/ # Master pages
190+
| | |-- base-fullscreen.html # Used by Authentication pages
191+
| | |-- base.html # Used by common pages
192+
| |
193+
| |-- accounts/ # Authentication pages
194+
| | |-- login.html # Login page
195+
| | |-- register.html # Register page
196+
| |
197+
| |-- home/ # UI Kit Pages
198+
| |-- index.html # Index page
199+
| |-- 404-page.html # 404 page
200+
| |-- *.html # All other pages
201+
|
202+
|-- requirements.txt # Development modules - SQLite storage
203+
|
204+
|-- .env # Inject Configuration via Environment
205+
|-- manage.py # Start the app - Django default start script
206+
|
207+
|-- ************************************************************************
208+
```
209+
210+
<br />
211+
212+
## ✨ PRO Version
213+
214+
> For more components, pages and priority on support, feel free to take a look at this amazing starter:
215+
216+
**Material Kit 2** is a premium design crafted by the `Creative-Tim` agency on top of Bootstrap 5 Framework. Designed for those who like bold elements and beautiful websites, Material Kit 2 is made of hundreds of elements, designed blocks, and fully coded pages built with an impressive level of quality.
217+
218+
- 👉 [Django Material Kit2 PRO](https://appseed.us/product/material-kit2-pro/django/) - product page
219+
- 👉 [Django Material Kit2 PRO](https://django-material-kit2-pro.appseed-srv1.com/) - LIVE Demo
220+
221+
<br >
222+
223+
![Mk2 PRO - Premium Seed project by AppSeed.](https://user-images.githubusercontent.com/51070104/168224733-b054bb46-d454-4aea-bb94-2d01bf4760d2.png)
224+
225+
<br />
226+
227+
---
228+
[Material Kit](https://appseed.us/generator/material-kit/) Django - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.

‎apps/__init__.py

Whitespace-only changes.

‎apps/authentication/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# -*- encoding: utf-8 -*-
2+
"""
3+
Copyright (c) 2019 - present AppSeed.us
4+
"""

‎apps/authentication/admin.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# -*- encoding: utf-8 -*-
2+
"""
3+
Copyright (c) 2019 - present AppSeed.us
4+
"""
5+
6+
from django.contrib import admin
7+
8+
# Register your models here.

‎apps/authentication/config.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# -*- encoding: utf-8 -*-
2+
"""
3+
Copyright (c) 2019 - present AppSeed.us
4+
"""
5+
6+
from django.apps import AppConfig
7+
8+
9+
class AuthConfig(AppConfig):
10+
name = 'apps.auth'
11+
label = 'apps_auth'

0 commit comments

Comments
 (0)