Skip to content

Commit 719c8b8

Browse files
app-generatorapp-generator
committed
UPD - Django MaterialPRO WPX
1 parent b2ddb62 commit 719c8b8

File tree

1 file changed

+182
-28
lines changed

1 file changed

+182
-28
lines changed

‎docs/products/django-dashboards/materialpro-wpx.mdx‎

Lines changed: 182 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,201 @@
11
---
2-
title: Django MaterialPro - Premium Starter
3-
sidebar_label: Django MaterialPro
2+
title: Django MaterialPro WPX - Premium Starter
3+
sidebar_label: Django MaterialPro WPX
44
---
55

6-
# [Django MaterialPro](https://appseed.us/product/material-wpx-pro/django/)
6+
# [Django MaterialPro](https://appseed.us/product/material-wpx-pro/django/) `WPX`
77

88
<SubHeading> Admin dashboard generated by AppSeed in Django on top of MaterialPro design (Premium version).</SubHeading>
99

10-
WrapPixel’s **MaterialPro Bootstrap Admin** is a premium bootstrap material design template that comes packed with new, fresh, and attractive designs and ready-to-use components.&#x20;
10+
WrapPixel’s **MaterialPro Bootstrap Admin** is a premium bootstrap material design template that comes packed with new, fresh, and attractive designs and ready-to-use components.
1111

12-
> Features
12+
- 👉 [MaterialPro Django](https://appseed.us/product/material-wpx-pro/django/) - `Product Page`
13+
- 👉 [MaterialPro Django](https://django-material-wpx-pro.appseed-srv1.com/) - `LIVE Demo`
1314

14-
- Codebase - [Django Dashboard Boilerplate](../../boilerplate-code/starters/django-dashboard.mdx)
15-
- UI Kit: [MaterialPro](../../content/bootstrap-template/materialpro-wpx.mdx) (premium version)&#x20;
16-
- SQLite Database, Django Native ORM
17-
- Session-Based Authentication, Forms validation
18-
- Deployment scripts: Docker, Gunicorn/Nginx&#x20;
15+
:::info [**v1.0.2**](https://github.com/app-generator/django-material-wpx-pro/releases) - release date `2021-11-13`
16+
:::
1917

20-
> Links
18+
<br />
2119

22-
- [MaterialPro Django](https://appseed.us/product/material-wpx-pro/django/) - product page
23-
- [MaterialPro Django](https://github.com/app-generator/django-material-wpx-pro) - public repository used for tracking issues &#x20;
24-
- [MaterialPro Django](https://django-material-wpx-pro.appseed-srv1.com/) - LIVE Demo
25-
- [Support](https://appseed.us/support): via **Github** (issues tracker) and [Discord](https://discord.gg/fZC6hup) - 24/7 LIVE Assistance.&#x20;
20+
> **Features**
2621
27-
## What is Django
22+
- ✅ UI Kit: **Material PRO Dashboard** (Lite Version) provided by **[WrapPixel](https://www.wrappixel.com/?ref=157)**
23+
- ✅ SQLite Database, Django Native ORM
24+
- ✅ Modular design, clean codebase
25+
- ✅ Session-Based Authentication, Forms validation
26+
- ✅ Deployment scripts: Docker, Gunicorn / Nginx
2827

29-
Django is a high-level Python Web framework that encourages rapid development and clean, pragmatic design. Built by experienced developers, it takes care of much of the hassle of Web development, so you can focus on writing your app without needing to reinvent the wheel. It’s free and open source.
28+
![Material Dashboard (WPX) - Premium Dashboard Template](https://github.com/app-generator/dummy/assets/51070104/1ced46f0-5faf-4e9d-905c-5ed1e11cd93a)
3029

31-
> Read more about [Django Framework](../../content/what-is/django.mdx)
30+
<br />
3231

33-
## How to use the App
32+
## Environment
3433

35-
- [Set up the environment](../../boilerplate-code/starters/django-dashboard.mdx#environment-1) - prepare your workstation for **Django**
36-
- [Compile the sources](../../boilerplate-code/starters/django-dashboard.mdx#build-the-app-1) - start this **Django** app in the local environment
37-
- [App Codebase](../../boilerplate-code/starters/django-dashboard.mdx#app-codebase) - how the project files are organized
38-
- [App Configuration](../../boilerplate-code/starters/django-dashboard.mdx#app-configuration) - how to configure this **Django** application
34+
To use the starter, [Python3](https://www.python.org) should be installed properly in the workstation.
35+
If you are not sure if Python is installed, please open a terminal and type `python --version`. Here is the full list with dependencies and tools required to build the app:
3936

40-
## MaterialPro WrapPixel - UI Kit
37+
- [Python3](https://www.python.org) - the programming language used to code the app
38+
- [GIT](https://git-scm.com) - used to clone the source code from the Github repository
39+
- Basic development tools (g++ compiler, python development libraries ..etc) used by Python to compile the app dependencies in your environment.
40+
- (Optional) `Docker` - a popular virtualization software
4141

42-
**Material Pro** Bootstrap Admin dashboard is versatile, user-friendly and has a clean code structure that optimizes the development cost and time. The smoothness and efficiency in using a customizable admin dashboard are felt with the reliable design inspiration by Google’s material design.
42+
<br />
4343

44-
- [MaterialPro Wpx](../../content/bootstrap-template/materialpro-wpx.mdx) - information provided by AppSeed
45-
- [MaterialPro Wpx](https://bit.ly/2NRHoFb) - product page hosted by [WrapPixel](../../content/partners/wrappixel.mdx).&#x20;
44+
## Start in `Docker`
4645

47-
![MaterialPro - Premium Bootstrap Template.](../../../static/assets/docs-cover-materialpro-wpx.jpg)
46+
> 👉 **Step 1** - Download the code from the [product page](https://appseed.us/product/material-wpx-pro/django/) (requires a purchase)
47+
48+
```bash
49+
$ unzip django-material-wpx-pro.zip
50+
$ cd django-material-wpx-pro
51+
```
52+
53+
> 👉 **Step 2** - Start the APP in `Docker`
54+
55+
```bash
56+
$ docker-compose up --build
57+
```
58+
59+
Visit `http://localhost:5085` in your browser. The app should be up & running.
60+
61+
<br />
62+
63+
## Manual Build
64+
65+
> 👉 **Step 1** - Download the code from the [product page](https://appseed.us/product/material-wpx-pro/django/) (requires a purchase)
66+
67+
```bash
68+
$ unzip django-material-wpx-pro.zip
69+
$ cd django-material-wpx-pro
70+
```
71+
72+
73+
### 👉 Set Up for `Unix`, `MacOS`
74+
75+
> Install modules via `VENV`
76+
77+
```bash
78+
$ virtualenv env
79+
$ source env/bin/activate
80+
$ pip3 install -r requirements.txt
81+
```
82+
83+
> Set Up Database
84+
85+
```bash
86+
$ python manage.py makemigrations
87+
$ python manage.py migrate
88+
```
89+
90+
> Start the app
91+
92+
```bash
93+
$ python manage.py runserver
94+
```
95+
96+
At this point, the app runs at `http://127.0.0.1:8000/`.
97+
98+
99+
### 👉 Set Up for `Windows`
100+
101+
> Install modules via `VENV` (windows)
102+
103+
```
104+
$ virtualenv env
105+
$ .\env\Scripts\activate
106+
$ pip3 install -r requirements.txt
107+
```
108+
109+
> Set Up Database
110+
111+
```bash
112+
$ python manage.py makemigrations
113+
$ python manage.py migrate
114+
```
115+
116+
> Start the app
117+
118+
```bash
119+
$ python manage.py runserver
120+
```
121+
122+
At this point, the app runs at `http://127.0.0.1:8000/`.
123+
124+
<br />
125+
126+
## Manage App `Users`
127+
128+
By default, the starter is not provided with users. To access the private pages and the admin section (reserved for `superusers`) follow up the next sections.
129+
130+
### 👉 Create `Superusers`
131+
132+
To access the `admin` section, Django requires `superuser` privilegies. Let's create a new `superuser` and access the `admin` section of the project:
133+
134+
```bash
135+
$ python manage.py createsuperuser
136+
```
137+
138+
Once the `superuser` is successfully created, we can access the `admin` section:
139+
140+
`http://localhost:8000/admin/` (make sure you have a `/` at the end).
141+
142+
<br />
143+
144+
## Codebase Structure
145+
146+
The project is coded using a simple and intuitive structure presented below:
147+
148+
```bash
149+
< PROJECT ROOT >
150+
|
151+
|-- core/ # Implements app configuration
152+
| |-- settings.py # Defines Global Settings
153+
| |-- wsgi.py # Start the app in production
154+
| |-- urls.py # Define URLs served by all apps/nodes
155+
|
156+
|-- apps/
157+
| |
158+
| |-- home/ # A simple app that serve HTML files
159+
| | |-- views.py # Serve HTML pages for authenticated users
160+
| | |-- urls.py # Define some super simple routes
161+
| |
162+
| |-- authentication/ # Handles auth routes (login and register)
163+
| | |-- urls.py # Define authentication routes
164+
| | |-- views.py # Handles login and registration
165+
| | |-- forms.py # Define auth forms (login and register)
166+
| |
167+
| |-- static/
168+
| | |-- <css, JS, images> # CSS files, Javascripts files
169+
| |
170+
| |-- templates/ # Templates used to render pages
171+
| |-- includes/ # HTML chunks and components
172+
| | |-- navigation.html # Top menu component
173+
| | |-- footer.html # App Footer
174+
| | |-- scripts.html # Scripts common to all pages
175+
| |
176+
| |-- layouts/ # Master pages
177+
| | |-- base.html # Used by common pages
178+
| |
179+
| |-- accounts/ # Authentication pages
180+
| | |-- login.html # Login page
181+
| | |-- register.html # Register page
182+
| |
183+
| |-- home/ # UI Kit Pages
184+
| |-- index.html # Index page
185+
| |-- page-404.html # 404 page
186+
| |-- *.html # All other pages
187+
|
188+
|-- requirements.txt # Development modules - SQLite storage
189+
|
190+
|-- .env # Inject Configuration via Environment
191+
|-- manage.py # Start the app - Django default start script
192+
|
193+
|-- ************************************************************************
194+
```
195+
196+
<br />
197+
198+
## Resources
199+
200+
- 👉 Free [Support](https://appseed.us/support/) via Email & Discord
201+
- 👉 [Custom Development Services](https://appseed.us/custom-development/) provided by experts

0 commit comments

Comments
 (0)