Skip to content

Commit 3aa9ed6

Browse files
app-generatorapp-generator
committed
Release v1.0.7
1 parent 941581d commit 3aa9ed6

File tree

340 files changed

+52447
-1
lines changed

Some content is hidden

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

340 files changed

+52447
-1
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: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
# Change Log
22

3-
## [1.0.6] 2022-05-24
3+
## [1.0.7] 2022-05-25
44
### Improvements
55

6+
- Built with [Soft UI Dashboard Generator](https://appseed.us/generator/soft-ui-dashboard/)
7+
- Timestamp: `2022-05-25 10:16`
68
- Added CDN/Static Server management
79
- `ASSETS_ROOT` env variable
10+
11+
## [1.0.6] 2022-05-24
12+
### Improvements
13+
814
- UI Update: `Soft UI Dashboard` v1.0.5
915
- upgrade Bootstrap version to v5.1.3
1016
- upgrade ChartJs plugin version to v3.7.1

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