Skip to content

Commit 179db15

Browse files
app-generatorapp-generator
authored
Initial commit
0 parents  commit 179db15

File tree

368 files changed

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

368 files changed

+58456
-0
lines changed

‎.env‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
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+
# No Slash at the end
9+
ASSETS_ROOT=/static/assets

‎.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: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Change Log
2+
3+
## [1.0.4] 2022-05-30
4+
### Improvements
5+
6+
- Built with [Material Kit Generator](https://appseed.us/generator/material-kit/)
7+
- Timestamp: `2022-05-31 07:49`
8+
9+
## [1.0.3] 2022-05-25
10+
### Improvements
11+
12+
- Built with [Material Kit Generator](https://appseed.us/generator/material-kit/)
13+
- Timestamp: `2022-05-25 22:04`
14+
- Codebase refactoring
15+
- Added CDN Support
16+
- via `.env` **ASSETS_ROOT**
17+
18+
## [1.0.2] 2021-01-19
19+
### Improvements
20+
21+
- Migrate all UI kit pages to Jinja
22+
23+
## [1.0.1] 2022-01-17
24+
### Improvements
25+
26+
- Bump Django Codebase to [v2.0.0](https://github.com/app-generator/boilerplate-code-django/releases)
27+
- Dependencies update (all packages)
28+
- Django==4.0.1
29+
- Settings update for Django 4.x
30+
- `New Parameter`: CSRF_TRUSTED_ORIGINS
31+
- [Origin header checking isn`t performed in older versions](https://docs.djangoproject.com/en/4.0/ref/settings/#csrf-trusted-origins)
32+
33+
## [1.0.0] 2021-10-30
34+
### Initial Release
35+
36+
- Bump UI: Material Kit v3.0.0
37+
- Update Bootstrap to v5.1.1
38+
- Update to Material Design 2
39+
- Codebase: [Django Boilerplate](https://github.com/app-generator/boilerplate-code-django) v1.0.6
40+
- Dependencies update (all packages)
41+
- Django==3.2.6 (latest stable version)
42+
- Codebase:
43+
- Better Code formatting
44+
- Improved Files organization
45+
- Optimize imports
46+
- Docker Scripts Update
47+
- Tooling: Added Gulp SCSS compilation scripts

‎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* >

‎Procfile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
web: gunicorn core.wsgi:application --log-file -

‎README.md‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
# [Django Material Kit](https://appseed.us/product/material-kit/django/)
2+
3+
`Open-Source` seed project generated by AppSeed in **Django** Framework on top of **[Material Kit](https://appseed.us/product/material-kit/django/)** 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+
- 👉 [Django Material Kit](https://appseed.us/product/material-kit/django/) - product page
6+
- 👉 [Django Material Kit](https://django-material-kit.appseed-srv1.com/) - LIVE App
7+
- 👉 [Complete documentation](https://docs.appseed.us/products/django-apps/material-kit) - `Learn how to use and update the product`
8+
9+
<br />
10+
11+
> 🚀 Built with [App Generator](https://appseed.us/generator/), Timestamp: `2022-09-18 07:49`
12+
13+
- ✅ `Up-to-date dependencies`
14+
- ✅ Database: `sqlite`
15+
- ✅ UI-Ready app, Django Native ORM
16+
- ✅ `Session-Based authentication`, Forms validation
17+
18+
<br />
19+
20+
![Material Kit - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/167396765-c88b7a95-155f-4236-8691-7b80fa2d9cd9.png)
21+
22+
<br />
23+
24+
## ✨ Start the app in Docker
25+
26+
> **Step 1** - Download the code from the GH repository (using `GIT`)
27+
28+
```bash
29+
$ git clone https://github.com/app-generator/django-material-kit.git
30+
$ cd django-material-kit
31+
```
32+
33+
<br />
34+
35+
> **Step 2** - Start the APP in `Docker`
36+
37+
```bash
38+
$ docker-compose up --build
39+
```
40+
41+
Visit `http://localhost:5085` in your browser. The app should be up & running.
42+
43+
<br />
44+
45+
## ✨ How to use it
46+
47+
> Download the code
48+
49+
```bash
50+
$ # Get the code
51+
$ git clone https://github.com/app-generator/django-material-kit.git
52+
$ cd django-material-kit
53+
```
54+
55+
<br />
56+
57+
### 👉 Set Up for `Unix`, `MacOS`
58+
59+
> Install modules via `VENV`
60+
61+
```bash
62+
$ virtualenv env
63+
$ source env/bin/activate
64+
$ pip3 install -r requirements.txt
65+
```
66+
67+
<br />
68+
69+
> Set Up Database
70+
71+
```bash
72+
$ python manage.py makemigrations
73+
$ python manage.py migrate
74+
```
75+
76+
<br />
77+
78+
> Start the app
79+
80+
```bash
81+
$ python manage.py runserver
82+
```
83+
84+
At this point, the app runs at `http://127.0.0.1:8000/`.
85+
86+
<br />
87+
88+
### 👉 Set Up for `Windows`
89+
90+
> Install modules via `VENV` (windows)
91+
92+
```
93+
$ virtualenv env
94+
$ .\env\Scripts\activate
95+
$ pip3 install -r requirements.txt
96+
```
97+
98+
<br />
99+
100+
> Set Up Database
101+
102+
```bash
103+
$ python manage.py makemigrations
104+
$ python manage.py migrate
105+
```
106+
107+
<br />
108+
109+
> Start the app
110+
111+
```bash
112+
$ python manage.py runserver
113+
```
114+
115+
At this point, the app runs at `http://127.0.0.1:8000/`.
116+
117+
<br />
118+
119+
## ✨ Create Users
120+
121+
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
122+
123+
- Start the app via `flask run`
124+
- Access the `registration` page and create a new user:
125+
- `http://127.0.0.1:8000/register/`
126+
- Access the `sign in` page and authenticate
127+
- `http://127.0.0.1:8000/login/`
128+
129+
<br />
130+
131+
## ✨ Code-base structure
132+
133+
The project is coded using a simple and intuitive structure presented below:
134+
135+
```bash
136+
< PROJECT ROOT >
137+
|
138+
|-- core/ # Implements app configuration
139+
| |-- settings.py # Defines Global Settings
140+
| |-- wsgi.py # Start the app in production
141+
| |-- urls.py # Define URLs served by all apps/nodes
142+
|
143+
|-- apps/
144+
| |
145+
| |-- home/ # A simple app that serve HTML files
146+
| | |-- views.py # Serve HTML pages for authenticated users
147+
| | |-- urls.py # Define some super simple routes
148+
| |
149+
| |-- authentication/ # Handles auth routes (login and register)
150+
| | |-- urls.py # Define authentication routes
151+
| | |-- views.py # Handles login and registration
152+
| | |-- forms.py # Define auth forms (login and register)
153+
| |
154+
| |-- static/
155+
| | |-- <css, JS, images> # CSS files, Javascripts files
156+
| |
157+
| |-- templates/ # Templates used to render pages
158+
| |-- includes/ # HTML chunks and components
159+
| | |-- navigation.html # Top menu component
160+
| | |-- footer.html # App Footer
161+
| | |-- scripts.html # Scripts common to all pages
162+
| |
163+
| |-- layouts/ # Master pages
164+
| | |-- base.html # Used by common pages
165+
| |
166+
| |-- accounts/ # Authentication pages
167+
| | |-- login.html # Login page
168+
| | |-- register.html # Register page
169+
| |
170+
| |-- home/ # UI Kit Pages
171+
| |-- index.html # Index page
172+
| |-- page-404.html # 404 page
173+
| |-- *.html # All other pages
174+
|
175+
|-- requirements.txt # Development modules - SQLite storage
176+
|
177+
|-- .env # Inject Configuration via Environment
178+
|-- manage.py # Start the app - Django default start script
179+
|
180+
|-- ************************************************************************
181+
```
182+
183+
<br />
184+
185+
## PRO Version
186+
187+
> For more components, pages and priority on support, feel free to take a look at this amazing starter:
188+
189+
**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.
190+
191+
- 👉 [Django Material Kit2 PRO](https://appseed.us/product/material-kit2-pro/django/) - product page
192+
- ✅ `Enhanced UI` - more pages and components
193+
- ✅ `Priority` on support
194+
195+
<br >
196+
197+
![Mk2 PRO - Premium Seed project by AppSeed.](https://user-images.githubusercontent.com/51070104/168224733-b054bb46-d454-4aea-bb94-2d01bf4760d2.png)
198+
199+
<br />
200+
201+
---
202+
[Django Material Kit](https://appseed.us/product/material-kit/django/) - Open-source starter generated by **[AppSeed Generator](https://appseed.us/generator/)**.

‎README_heroku.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
heroku login
2+
heroku create
3+
git push heroku master
4+
heroku run python manage.py migrate
5+
heroku open
6+
heroku run bash
7+

‎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+
"""

0 commit comments

Comments
 (0)