|
1 |
| -# [CoreUI Django](https://appseed.us/product/coreui/django/) |
2 |
| - |
3 |
| -Open-source **[Django Dashboard](https://appseed.us/admin-dashboards/django/)** generated by `AppSeed` on top of an iconic design. For newcomers, **CoreUI** is one of the best open-source admin dashboard & control panel themes. Built on top of Bootstrap, `CoreUI` provides a range of responsive, reusable, and commonly used components. |
4 |
| - |
5 |
| -- 👉 [CoreUI Django](https://appseed.us/product/coreui/django/) - `Product page` |
6 |
| -- 👉 [CoreUI Django](https://django-coreui.onrender.com/) - `LIVE Demo` |
| 1 | +# [Django CoreUI](https://app-generator.dev/product/coreui/django/) |
| 2 | + |
| 3 | +Open-source **Django Dashboard** built on top of CoreO, on top of an iconic open-source Bootstrap-based design. For newcomers, **CoreUI** is one of the best open-source admin dashboard & control panel themes. Built on top of Bootstrap, `CoreUI` provides a range of responsive, reusable, and commonly used components. |
| 4 | + |
| 5 | +- 👉 [Django CoreUI](https://app-generator.dev/product/coreui/django/) - `Product Page` |
| 6 | +- 👉 [Django CoreUI](https://django-coreui.appseed-srv1.com/) - `LIVE Demo` |
| 7 | +- 👉 [Django CoreUI](https://app-generator.dev/docs/products/django/coreui/index.html) - `Complete Information` and Support Links |
| 8 | + - [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - a `comprehensive tutorial` |
| 9 | + - `Configuration`: Install Dependencies, Prepare Environment, Setting up the Database |
| 10 | + - `Start with Docker` |
| 11 | + - `Manual Build` |
| 12 | + - `Start the project` |
| 13 | + - `Deploy on Render` |
7 | 14 |
|
8 | 15 | <br />
|
9 | 16 |
|
10 | 17 | ## Features
|
11 | 18 |
|
12 |
| -> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed** |
13 |
| -
|
14 |
| -| Free Version | [PRO Version](https://appseed.us/product/material-dashboard2-pro/django/) | [Custom Development](https://appseed.us/custom-development/) | |
15 |
| -| --------------------------------------| --------------------------------------| --------------------------------------| |
16 |
| -| ✓ **Django 4.2.9** | **Everything in Free**, plus: | **Everything in PRO**, plus: | |
17 |
| -| ✓ Best Practices | ✅ **Premium Bootstrap 5 Design** | ✅ **1mo Custom Development** | |
18 |
| -| ✓ Bootstrap 4, `Material` Design | ✅ `OAuth` Google, GitHub | ✅ **Team**: PM, Developer, Tester | |
19 |
| -| ✓ `CI/CD` Flow via Render | ✅ `API`, **[Charts](https://django-material-dash2-pro.onrender.com/charts/)** | ✅ Weekly Sprints | |
20 |
| -| ✓ `Docker` | ✅ **[DataTables](https://django-material-dash2-pro.onrender.com/tables/)** (Filters, Export) | ✅ Technical SPECS | |
21 |
| -| - |✅ **Celery** | ✅ Documentation | |
22 |
| -| - | ✅ **Media Files Manager** | ✅ **30 days Delivery Warranty** | |
23 |
| -| - | ✅ **Extended User Profiles** | - | |
24 |
| -| - | ✅ `Private REPO Access` | - | |
25 |
| -| - | ✅ **PRO Support** - [Email & Discord](https://appseed.us/support/) | - | |
26 |
| -| - | ✅ Deployment Assistance | - | |
27 |
| -| ------------------------------------ | ------------------------------------ | ------------------------------------| |
28 |
| -| ✓ [LIVE Demo](https://django-coreui.appseed-srv1.com/) | 🚀 [LIVE Demo](https://django-material-dash2-pro.onrender.com/) | **[Get in Touch ➡️](https://appseed.us/custom-development/)** | |
| 19 | +- **Django 4.1.12** |
| 20 | +- Best Practices |
| 21 | +- **Berry Dashboard Dashboard** - Full Integration |
| 22 | +- `CI/CD` Flow via Render |
| 23 | +- `Docker` |
29 | 24 |
|
30 | 25 | 
|
31 | 26 |
|
32 |
| -<br /> |
33 |
| - |
34 |
| -## ✨ Start the app in Docker |
35 |
| - |
36 |
| -> **Step 1** - Download the code from the GH repository (using `GIT`) |
37 |
| -
|
38 |
| -```bash |
39 |
| -$ git clone https://github.com/app-generator/django-coreui.git |
40 |
| -$ cd django-coreui |
41 |
| -``` |
42 |
| - |
43 |
| -<br /> |
44 |
| - |
45 |
| -> **Step 2** - Start the APP in `Docker` |
46 |
| -
|
47 |
| -```bash |
48 |
| -$ docker-compose up --build |
49 |
| -``` |
50 |
| - |
51 |
| -Visit `http://localhost:5085` in your browser. The app should be up & running. |
52 |
| - |
53 |
| -<br /> |
54 |
| - |
55 |
| -## ✨ How to use it |
56 |
| - |
57 |
| -> Download the code |
58 |
| -
|
59 |
| -```bash |
60 |
| -$ git clone https://github.com/app-generator/django-coreui.git |
61 |
| -$ cd django-coreui |
62 |
| -``` |
63 |
| - |
64 |
| -<br /> |
65 |
| - |
66 |
| -### 👉 Set Up for `Unix`, `MacOS` |
67 |
| - |
68 |
| -> Install modules via `VENV` |
69 |
| -
|
70 |
| -```bash |
71 |
| -$ virtualenv env |
72 |
| -$ source env/bin/activate |
73 |
| -$ pip3 install -r requirements.txt |
74 |
| -``` |
75 |
| - |
76 |
| -> Install JS Dependencies |
77 |
| -
|
78 |
| -```bash |
79 |
| -$ cd static/assets |
80 |
| -$ npm i |
81 |
| -``` |
82 |
| - |
83 |
| -<br /> |
84 |
| - |
85 |
| -> Set Up Database |
86 |
| -
|
87 |
| -```bash |
88 |
| -$ python manage.py makemigrations |
89 |
| -$ python manage.py migrate |
90 |
| -``` |
91 |
| - |
92 |
| -<br /> |
93 |
| - |
94 |
| -> Start the app |
95 |
| -
|
96 |
| -```bash |
97 |
| -$ python manage.py runserver |
98 |
| -``` |
99 |
| - |
100 |
| -At this point, the app runs at `http://127.0.0.1:8000/`. |
101 |
| - |
102 |
| -<br /> |
103 |
| - |
104 |
| -### 👉 Set Up for `Windows` |
105 |
| - |
106 |
| -> Install modules via `VENV` (windows) |
107 |
| -
|
108 |
| -``` |
109 |
| -$ virtualenv env |
110 |
| -$ .\env\Scripts\activate |
111 |
| -$ pip3 install -r requirements.txt |
112 |
| -``` |
113 |
| - |
114 | 27 | <br />
|
115 | 28 |
|
116 |
| -> Set Up Database |
117 |
| -
|
118 |
| -```bash |
119 |
| -$ python manage.py makemigrations |
120 |
| -$ python manage.py migrate |
121 |
| -``` |
122 |
| - |
123 |
| -<br /> |
124 |
| - |
125 |
| -> Start the app |
126 |
| -
|
127 |
| -```bash |
128 |
| -$ python manage.py runserver |
129 |
| -``` |
130 |
| - |
131 |
| -At this point, the app runs at `http://127.0.0.1:8000/`. |
132 |
| - |
133 |
| -<br /> |
134 |
| - |
135 |
| -### 👉 Create Users |
136 |
| - |
137 |
| -By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up: |
138 |
| - |
139 |
| -- Start the app via `flask run` |
140 |
| -- Access the `registration` page and create a new user: |
141 |
| - - `http://127.0.0.1:8000/register/` |
142 |
| -- Access the `sign in` page and authenticate |
143 |
| - - `http://127.0.0.1:8000/login/` |
144 |
| - |
145 |
| -<br /> |
146 |
| - |
147 |
| -## ✨ Code-base structure |
148 |
| - |
149 |
| -The project is coded using a simple and intuitive structure presented below: |
150 |
| - |
151 |
| -```bash |
152 |
| -< PROJECT ROOT > |
153 |
| - | |
154 |
| - |-- core/ # Implements app configuration |
155 |
| - | |-- settings.py # Defines Global Settings |
156 |
| - | |-- wsgi.py # Start the app in production |
157 |
| - | |-- urls.py # Define URLs served by all apps/nodes |
158 |
| - | |
159 |
| - |-- apps/ |
160 |
| - | | |
161 |
| - | |-- home/ # A simple app that serve HTML files |
162 |
| - | | |-- views.py # Serve HTML pages for authenticated users |
163 |
| - | | |-- urls.py # Define some super simple routes |
164 |
| - | | |
165 |
| - | |-- authentication/ # Handles auth routes (login and register) |
166 |
| - | | |-- urls.py # Define authentication routes |
167 |
| - | | |-- views.py # Handles login and registration |
168 |
| - | | |-- forms.py # Define auth forms (login and register) |
169 |
| - | | |
170 |
| - | |-- static/ |
171 |
| - | | |-- <css, JS, images> # CSS files, Javascripts files |
172 |
| - | | |
173 |
| - | |-- templates/ # Templates used to render pages |
174 |
| - | |-- includes/ # HTML chunks and components |
175 |
| - | | |-- navigation.html # Top menu component |
176 |
| - | | |-- sidebar.html # Sidebar component |
177 |
| - | | |-- footer.html # App Footer |
178 |
| - | | |-- scripts.html # Scripts common to all pages |
179 |
| - | | |
180 |
| - | |-- layouts/ # Master pages |
181 |
| - | | |-- base-fullscreen.html # Used by Authentication pages |
182 |
| - | | |-- base.html # Used by common pages |
183 |
| - | | |
184 |
| - | |-- accounts/ # Authentication pages |
185 |
| - | | |-- login.html # Login page |
186 |
| - | | |-- register.html # Register page |
187 |
| - | | |
188 |
| - | |-- home/ # UI Kit Pages |
189 |
| - | |-- index.html # Index page |
190 |
| - | |-- 404-page.html # 404 page |
191 |
| - | |-- *.html # All other pages |
192 |
| - | |
193 |
| - |-- requirements.txt # Development modules - SQLite storage |
194 |
| - | |
195 |
| - |-- .env # Inject Configuration via Environment |
196 |
| - |-- manage.py # Start the app - Django default start script |
197 |
| - | |
198 |
| - |-- ************************************************************************ |
199 |
| -``` |
200 |
| - |
201 |
| -<br /> |
202 |
| - |
203 |
| -## PRO Version |
204 |
| - |
205 |
| -> For more components, pages, and priority on support, feel free to take a look at this amazing starter: |
206 |
| -
|
207 |
| -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. |
| 29 | +## [Material Dashboard PRO Version](https://app-generator.dev/product/material-dashboard-pro/django/) |
208 | 30 |
|
209 |
| -- 👉 [Soft UI Dashboard PRO Django](https://appseed.us/product/soft-ui-dashboard-pro/django/) - Product Page |
210 |
| -- 👉 [Soft UI Dashboard PRO Django](https://django-soft-ui-dashboard-pro.appseed-srv1.com/) - LIVE Demo |
| 31 | +> The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://django-material-dash2-pro.onrender.com). |
211 | 32 |
|
212 |
| -<br > |
| 33 | +- **Simple, Easy-to-Extend** Codebase |
| 34 | +- **Material Dashboard** Design - PRO Version |
| 35 | +- Bootstrap 5 CSS |
| 36 | +- **OAuth** - Github |
| 37 | +- **Extended User Profile** |
| 38 | +- **API** via DRF |
| 39 | +- **Charts** via ApexJS |
| 40 | +- **Celery** (async tasks) |
| 41 | +- **Deployment-Ready** for Render |
213 | 42 |
|
214 |
| - |
| 43 | + |
215 | 44 |
|
216 | 45 | <br />
|
217 | 46 |
|
218 | 47 | ---
|
219 |
| -[CoreUI Django](https://appseed.us/product/coreui/django/) - Open-source `Django Template` crafted by **[AppSeed](https://appseed.us)**. |
| 48 | +[Django CoreUI](https://app-generator.dev/product/coreui/django/) - Open-Source **Django** Starter provided by [App Generator](https://app-generator.dev) |
0 commit comments