|
1 | | -# [Gradient Able Django](https://appseed.us/product/gradient-able/django/) |
2 | 1 |
|
3 | | -Open-source **[Django Dashboard](https://appseed.us/admin-dashboards/django/)** generated by `AppSeed` on top of a modern design. `Gradient Able` Bootstrap Lite is the most stylized Bootstrap Lite Admin Template, among all other Lite/Free admin templates in the market. It comes with highly feature-rich pages and components with fully developer-centric code. |
| 2 | +# [Django Gradient Able](https://app-generator.dev/product/gradient-able/django/) |
4 | 3 |
|
5 | | -- 👉 [Gradient Able Django](https://appseed.us/product/gradient-able/django/) - Product page |
6 | | -- 👉 [Gradient Able Django](https://django-gradient-able.appseed-srv1.com/) - LIVE deployment |
| 4 | +Open-source **Django** project crafted on top of **Gradient Able Dashboard**, an open-source `Bootstrap` design. |
| 5 | +The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. |
7 | 6 |
|
8 | | -<br /> |
9 | | - |
10 | | -## Features |
11 | | - |
12 | | -> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed** |
13 | | -
|
14 | | -| Free Version | [PRO Version](https://appseed.us/product/gradient-able-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** | ✅ **1 Week** `Custom Development` | |
18 | | -| ✓ Bootstrap 4, `Datta Able` Design | ✅ `OAuth` GitHub | ✅ **Team**: PM, Developer, Tester | |
19 | | -| ✓ `Docker` | ✅ `API`, **[Charts](https://django-gradient-pro.onrender.com/charts/)** | ✅ Weekly Sprints | |
20 | | -| ✓ `CI/CD` Flow via Render | ✅ **[DataTables](https://django-gradient-pro.onrender.com/tables/)** (Filters, Export) | ✅ Technical SPECS | |
21 | | -| ✓ `Free Support` (GitHub Issues) | ✅ **Celery** | ✅ Documentation | |
22 | | -| - | ✅ **Media Files Manager** | ✅ **30 days Delivery Warranty** | |
23 | | -| - | ✅ **Extended User Profiles** | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)** | |
24 | | -| - | ✅ `Private REPO Access` | - | |
25 | | -| - | ✅ **[Premium Support](https://appseed.us/support/)** | - | |
26 | | -| ------------------------------------ | ------------------------------------ | ------------------------------------| |
27 | | -| ✓ [LIVE Demo](https://django-gradient-able.appseed-srv1.com/) | 🚀 [LIVE Demo](https://django-gradient-pro.onrender.com/) | 🛒 `Order`: **[$999](https://appseed.gumroad.com/l/rocket-package-week)** (GUMROAD) | |
28 | | - |
29 | | - |
30 | | - |
31 | | -<br /> |
32 | | - |
33 | | -## Start with `Docker` |
34 | | - |
35 | | -> 👉 **Step 1** - Download the code from the GH repository (using `GIT`) |
36 | | -
|
37 | | -```bash |
38 | | -$ git clone https://github.com/app-generator/django-gradient-able.git |
39 | | -$ cd django-gradient-able |
40 | | -``` |
41 | | - |
42 | | -<br /> |
43 | | - |
44 | | -> 👉 **Step 2** - Start the APP in `Docker` |
45 | | -
|
46 | | -```bash |
47 | | -$ docker-compose up --build |
48 | | -``` |
49 | | - |
50 | | -Visit `http://localhost:5085` in your browser. The app should be up & running. |
51 | | - |
52 | | -<br /> |
53 | | - |
54 | | -## Environment |
55 | | - |
56 | | -Create a new `.env` file using sample `env.sample`. The meaning of each variable can be found below: |
57 | | - |
58 | | -- `DEBUG`: if `True` the app runs in develoment mode |
59 | | - - For production value `False` should be used |
60 | | -- For `MySql` persistence |
61 | | - - Install the DB Driver: `pip install mysqlclient` |
62 | | - - Create DB and assign a new user (full rights) |
63 | | - - Edit `.env` to match the DB, user, password .. |
64 | | - |
65 | | -<br /> |
66 | | - |
67 | | -## Manual Build |
68 | | - |
69 | | -> Download the code |
70 | | -
|
71 | | -```bash |
72 | | -$ git clone https://github.com/app-generator/django-gradient-able.git |
73 | | -$ cd django-gradient-able |
74 | | -``` |
| 7 | +- 👉 [Django Gradient Able](https://app-generator.dev/docs/products/django/gradient-able/index.html) - **Complete Documentation** |
| 8 | +- 👉 [Django Gradient Able](https://django-gradient-able.appseed-srv1.com/) - LIVE Demo |
| 9 | +- 👉 [Get Support](https://app-generator.dev/ticket/create/) via Email and Discord |
75 | 10 |
|
76 | 11 | <br /> |
77 | 12 |
|
78 | | -### 👉 Set Up for `Unix`, `MacOS` |
79 | | - |
80 | | -> Install modules via `VENV` |
81 | | -
|
82 | | -```bash |
83 | | -$ virtualenv env |
84 | | -$ source env/bin/activate |
85 | | -$ pip3 install -r requirements.txt |
86 | | -``` |
87 | | - |
88 | | -<br /> |
89 | | - |
90 | | -> Set Up Database |
91 | | -
|
92 | | -```bash |
93 | | -$ python manage.py makemigrations |
94 | | -$ python manage.py migrate |
95 | | -``` |
96 | | - |
97 | | -<br /> |
98 | | - |
99 | | -> Start the APP |
100 | | -
|
101 | | -```bash |
102 | | -$ python manage.py createsuperuser # create the admin |
103 | | -$ python manage.py runserver # start the project |
104 | | -``` |
105 | | - |
106 | | -At this point, the app runs at `http://127.0.0.1:8000/`. |
107 | | - |
108 | | -<br /> |
109 | | - |
110 | | -### 👉 Set Up for `Windows` |
111 | | - |
112 | | -> Install modules via `VENV` (windows) |
113 | | -
|
114 | | -``` |
115 | | -$ virtualenv env |
116 | | -$ .\env\Scripts\activate |
117 | | -$ pip3 install -r requirements.txt |
118 | | -``` |
119 | | - |
120 | | -<br /> |
121 | | - |
122 | | -> Set Up Database |
123 | | -
|
124 | | -```bash |
125 | | -$ python manage.py makemigrations |
126 | | -$ python manage.py migrate |
127 | | -``` |
128 | | - |
129 | | -<br /> |
130 | | - |
131 | | -> Start the APP |
132 | | -
|
133 | | -```bash |
134 | | -$ python manage.py createsuperuser # create the admin |
135 | | -$ python manage.py runserver # start the project |
136 | | -``` |
137 | | - |
138 | | - |
139 | | -At this point, the app runs at `http://127.0.0.1:8000/`. |
140 | | - |
141 | | -<br /> |
142 | | - |
143 | | -<br /> |
144 | | - |
145 | | -## Codebase Structure |
146 | | - |
147 | | -The project is coded using a simple and intuitive structure presented below: |
148 | | - |
149 | | -```bash |
150 | | -< PROJECT ROOT > |
151 | | - | |
152 | | - |-- core/ |
153 | | - | |-- settings.py # Project Configuration |
154 | | - | |-- urls.py # Project Routing |
155 | | - | |
156 | | - |-- home/ |
157 | | - | |-- views.py # APP Views |
158 | | - | |-- urls.py # APP Routing |
159 | | - | |-- models.py # APP Models |
160 | | - | |-- tests.py # Tests |
161 | | - | |-- templates/ # Theme Customisation |
162 | | - | |-- pages # |
163 | | - | |-- custom-index.py # Custom Dashboard |
164 | | - | |
165 | | - |-- requirements.txt # Project Dependencies |
166 | | - | |
167 | | - |-- env.sample # ENV Configuration (default values) |
168 | | - |-- manage.py # Start the app - Django default start script |
169 | | - | |
170 | | - |-- ************************************************************************ |
171 | | -``` |
172 | | - |
173 | | -<br /> |
174 | | - |
175 | | -## How to Customize |
176 | | - |
177 | | -When a template file is loaded in the controller, `Django` scans all template directories starting from the ones defined by the user, and returns the first match or an error in case the template is not found. |
178 | | -The theme used to style this starter provides the following files: |
179 | | - |
180 | | -```bash |
181 | | -# This exists in ENV: LIB/admin_gradient |
182 | | -< UI_LIBRARY_ROOT > |
183 | | - | |
184 | | - |-- templates/ # Root Templates Folder |
185 | | - | | |
186 | | - | |-- accounts/ |
187 | | - | | |-- login.html # Sign IN Page |
188 | | - | | |-- register.html # Sign UP Page |
189 | | - | | |
190 | | - | |-- includes/ |
191 | | - | | |-- footer.html # Footer component |
192 | | - | | |-- sidebar.html # Sidebar component |
193 | | - | | |-- navigation.html # Navigation Bar |
194 | | - | | |-- scripts.html # Scripts Component |
195 | | - | | |
196 | | - | |-- layouts/ |
197 | | - | | |-- base.html # Masterpage |
198 | | - | | |-- base-auth.html # Masterpage for Auth Pages |
199 | | - | | |
200 | | - | |-- pages/ |
201 | | - | |-- index.html # Dashboard Page |
202 | | - | |-- profile.html # Profile Page |
203 | | - | |-- *.html # All other pages |
204 | | - | |
205 | | - |-- ************************************************************************ |
206 | | -``` |
207 | | - |
208 | | -When the project requires customization, we need to copy the original file that needs an update (from the virtual environment) and place it in the template folder using the same path. |
209 | | - |
210 | | -> For instance, if we want to **customize the index.html** these are the steps: |
211 | | -
|
212 | | -- ✅ `Step 1`: create the `templates` DIRECTORY inside the `home` app |
213 | | -- ✅ `Step 2`: configure the project to use this new template directory |
214 | | - - `core/settings.py` TEMPLATES section |
215 | | -- ✅ `Step 3`: copy the `index.html` from the original location (inside your ENV) and save it to the `home/templates` DIR |
216 | | - - Source PATH: `<YOUR_ENV>/LIB/admin_gradient/pages/index.html` |
217 | | - - Destination PATH: `<PROJECT_ROOT>home/templates/pages/index.html` |
218 | | - |
219 | | -> To speed up all these steps, the **codebase is already configured** (`Steps 1, and 2`) and a `custom dashboard` can be found at this location: |
220 | | -
|
221 | | -`home/templates/pages/custom-index.html` |
222 | | - |
223 | | -By default, this file is unused because the `theme` expects `index.html` (without the `custom-` prefix). |
224 | | - |
225 | | -In order to use it, simply rename it to `index.html`. Like this, the default version shipped in the library is ignored by Django. |
226 | | - |
227 | | -In a similar way, all other files and components can be customized easily. |
228 | | - |
229 | | -<br /> |
230 | | - |
231 | | -## Deploy on [Render](https://render.com/) |
232 | | - |
233 | | -- Create a Blueprint instance |
234 | | - - Go to https://dashboard.render.com/blueprints this link. |
235 | | -- Click `New Blueprint Instance` button. |
236 | | -- Connect your `repo` which you want to deploy. |
237 | | -- Fill the `Service Group Name` and click on `Update Existing Resources` button. |
238 | | -- After that your deployment will start automatically. |
239 | | - |
240 | | -At this point, the product should be LIVE. |
241 | | - |
242 | | -<br /> |
243 | | - |
244 | | -## [Gradient Able](https://appseed.us/product/gradient-able-pro/django/) `PRO Version` |
245 | | - |
246 | | -> For more components, pages and priority on support, feel free to take a look at this **Django** starter: |
247 | | -
|
248 | | -Designed for those who like bold elements and beautiful websites, **[Gradient Able](https://appseed.us/product/gradient-able-pro/django/)** is the most stylish Admin Design compare to all other Bootstrap Templates. |
249 | | -It comes with high feature-rich pages and components with fully developer-centric code. |
250 | | - |
251 | | -- [Gradient Datta PRO](https://appseed.us/product/datta-able-pro/django/) - product page |
252 | | - - `Enhanced UI` - more pages and components |
253 | | - - `Priority` on support |
| 13 | +## Features |
254 | 14 |
|
255 | | -<br > |
| 15 | +- **Django 4.1.12** |
| 16 | +- Best Practices |
| 17 | +- API Generator |
| 18 | +- DataTables |
| 19 | +- [Gradient Able Dashboard](https://app-generator.dev/docs/templates/bootstrap/gradient-able.html) - Full Integration |
| 20 | +- `CI/CD` Flow via Render |
| 21 | +- `Docker` |
256 | 22 |
|
257 | | - |
| 23 | + |
258 | 24 |
|
259 | 25 | <br /> |
260 | 26 |
|
261 | 27 | --- |
262 | | -[Gradient Able Django](https://appseed.us/product/gradient-able/django/)- Open-source starter crafted by **[AppSeed](https://appseed.us)**. |
| 28 | +[Django Gradient Able](https://app-generator.dev/product/gradient-able/django/) - Open-Source **Django** Starter provided by [App Generator](https://app-generator.dev) |
0 commit comments