|
1 | | -<div align="center"> |
2 | | - <a href="https://appseed.us/product/rocket/django/"> |
3 | | - <img src="https://github-production-user-asset-6210df.s3.amazonaws.com/51070104/272178364-cbac6d97-b2dc-4d95-bab6-891f4ee7d84d.png"" width="64" height="64" alt="Rocket Icon"> |
4 | | - </a> |
5 | | - <h1> |
6 | | - <a href="https://appseed.us/product/rocket/django/"> |
7 | | - Rocket Django |
8 | | - </a> |
9 | | - </h1> |
10 | | - <p> |
11 | | - <strong>TailwindCSS</strong> • <strong>Flowbite</strong> • <strong>API (DRF)</strong> • <strong>Celery Beat</strong> • <strong>DataTables</strong> • <strong>Charts</strong> • <strong>Docker</strong> • <strong>CI/CD</strong> |
12 | | - </p> |
13 | | - <h3> |
14 | | - <a href="https://rocket-django.onrender.com/"> |
15 | | - Demo |
16 | | - </a> |
17 | | - • |
18 | | - <a href="https://appseed.us/support/"> |
19 | | - Support |
20 | | - </a> |
21 | | - • |
22 | | - <a href="https://appseed.us/product/rocket-pro/django/"> |
23 | | - PRO Version |
24 | | - </a> |
25 | | - </h3> |
26 | | -</div> |
| 1 | +# [Django Rocket](https://app-generator.dev/product/rocket/django/) |
27 | 2 |
|
28 | | -<br /> |
29 | | - |
30 | | -<div align="center"> |
31 | | - <img src="https://github-production-user-asset-6210df.s3.amazonaws.com/51070104/272299949-6f4a8fd7-7cce-472a-9566-9519db338c7d.gif" alt="Django Rocket - Open-source Starter styled with Tailwind and Flowbite."> |
32 | | -</div> |
33 | | - |
34 | | -<br /> |
35 | | - |
36 | | -## `Features` |
37 | | - |
38 | | -> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed** |
39 | | -
|
40 | | -| [Free Version](https://appseed.us/product/rocket/django/) | [PRO Version](https://appseed.us/product/rocket-pro/django/) | [Custom Development](https://appseed.us/custom-development/) | |
41 | | -| --------------------------------------| --------------------------------------| --------------------------------------| |
42 | | -| ✓ **Django 4.2.9** | **Everything in Free**, plus: | **Everything in PRO**, plus: | |
43 | | -| ✓ **Best Practices**, `Modular Codebase` | ✅ **OAuth** `GitHub` | ✅ **1 Week** `Custom Development` | |
44 | | -| ✓ **TailwindCSS**/`Flowbite` | ✅ **Media Files Manager** | ✅ **Team**: PM, Developer, Tester | |
45 | | -| ✓ Extended User Model | ✅ **React** / `ApexCharts` | ✅ Weekly Sprints | |
46 | | -| ✓ `Simple` [Charts](https://rocket-django.onrender.com/charts/) | ✅ **Enhanced** [Charts](https://rocket-django-pro.onrender.com/charts/) | ✅ Technical SPECS | |
47 | | -| ✓ `Simple` [DataTables](https://rocket-django.onrender.com/tables/) | ✅ **Enhanced** [DataTables](https://rocket-django-pro.onrender.com/tables/) | ✅ Documentation | |
48 | | -| ✓ [API](https://rocket-django.onrender.com/api/product/) via `DRF` | ✅ **Multi-Language** (i18n) | ✅ **30 days Delivery Warranty** | |
49 | | -| ✓ `Docker` | ✅ **Sentry** `Error Reporting` | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)** | |
50 | | -| ✓ `Free Support` (GitHub Issues) | ✅ **[Celery](https://rocket-django.onrender.com/tasks/)** (async tasks) | - | |
51 | | -| - | ✅ **[Premium Support](https://appseed.us/support/)** | - | |
52 | | -| - | ✅ `Unlimited Projects` & **SaaS** | - | |
53 | | -| - | ✅ `Private REPO Access` | - | |
54 | | -| - | ✅ `Lifetime Updates` | - | |
55 | | -| ------------------------------------| ------------------------------------| ------------------------------------| |
56 | | -| ✓ [Rocket Demo](https://rocket-django.onrender.com/) | 🚀 **[Rocket PRO Demo](https://rocket-django-pro.onrender.com/)** | **[Get in Touch ➡️](https://appseed.us/custom-development/)** | |
57 | | - |
58 | | -<br /> |
59 | | - |
60 | | -## Why [Rocket Django](https://appseed.us/product/rocket/django/) |
61 | | - |
62 | | -#### ***Supercharge your app instantly, launch faster, make $*** |
63 | | - |
64 | | -Login users, process payments and send emails at lightspeed. Spend your time building your startup, not integrating APIs. **Rocket Django** provides you with the boilerplate code you need to launch, FAST. |
| 3 | +Open-source **Django Starter with Rocket Design**, a product styled with Tailwind/Flowbite. |
| 4 | +The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. |
65 | 5 |
|
66 | | -#### ***Rocket your startup in days, not weeks*** |
67 | | - |
68 | | -The Django boilerplate has all you need to build your SaaS, Analytics tool, or any other type of Web App. From idea to production in 5 minutes. |
69 | | - |
70 | | -#### **48+ hours of headaches** |
71 | | - |
72 | | - - 1 hrs to setup the project |
73 | | - - 2 hrs integrate tooling |
74 | | - - 10 hr for coding Datatables |
75 | | - - 5 hr for having thr Charts |
76 | | - - 2 hrs for Docker |
77 | | - - ∞ hrs overthinking... |
78 | | - - Free [Support](https://appseed.us/support/) via `Email` & [Discord](https://discord.gg/fZC6hup) |
| 6 | +- 👉 [Django Rocket](https://app-generator.dev/docs/products/django/rocket/index.html) - **Complete Documentation** |
| 7 | +- 👉 [Django Rocket](https://rocket-django.onrender.com) - LIVE Demo |
| 8 | +- 👉 [Get Support](https://app-generator.dev/ticket/create/) via Email and Discord |
79 | 9 |
|
80 | 10 | <br /> |
81 | 11 |
|
82 | | -## Download Sources |
83 | | - |
84 | | -The product can be downloaded from the [official page](https://appseed.us/product/rocket/django/) or GitHub using GIT: |
| 12 | +## Features |
85 | 13 |
|
86 | | -```bash |
87 | | -$ git clone https://github.com/app-generator/rocket-django.git |
88 | | -$ cd rocket-django |
89 | | -``` |
| 14 | +- Simple, Easy-to-Extend codebase |
| 15 | +- Styling: Flowbite/Tailwind |
| 16 | +- Extended User Model |
| 17 | +- ApexJS Charts |
| 18 | +- DataTables |
| 19 | +- API |
| 20 | +- DB Persistence: SQLite/MySql/PostgreSQL |
| 21 | +- Docker |
| 22 | +- CI/CD integration for Render |
90 | 23 |
|
91 | | -Once the sources are available in the local filesystem, we can start the project using `Docker` or `manual build`. |
| 24 | + |
92 | 25 |
|
93 | 26 | <br /> |
94 | 27 |
|
95 | | -## Start with `Docker` |
96 | | - |
97 | | -```bash |
98 | | -# Optional (kill all existing containers) |
99 | | -$ docker container kill $(docker ps -q) ; docker container rm $(docker ps -a -q) ; docker network prune -f |
100 | | -# Start the APP |
101 | | -$ docker-compose up --build |
102 | | -``` |
103 | | - |
104 | | -Visit `http://localhost:5085` in your browser. The app should be up & running. The starter comes with two default users: |
105 | | - |
106 | | -- Ordinary user: `test` / `test@appseed.us` / `Pass12__` (the password) |
107 | | -- Django SuperUser (admin): `admin` / `admin@appseed.us` / `Pass12__` (the password) |
108 | | - |
109 | | -Once authenticated with the above credentials, the sidebar shows different items. |
110 | | - |
111 | | -<br /> |
112 | | - |
113 | | -## Manual Build |
114 | | - |
115 | | -> 👉 Create `.env` from `env.sample` |
116 | | -
|
117 | | -```env |
118 | | -DEBUG=False |
119 | | -
|
120 | | -SECRET_KEY=<STRONG_KEY_HERE> |
121 | | -``` |
122 | | - |
123 | | -> 👉 Install **Django** modules via `VENV` |
124 | | -
|
125 | | -```bash |
126 | | -$ virtualenv env |
127 | | -$ source env/bin/activate |
128 | | -$ pip install -r requirements.txt |
129 | | -``` |
130 | | - |
131 | | -> 👉 Install **Tailwind/Flowbite** (another terminal) |
132 | | -
|
133 | | -Tested with **Node** `v18.20.0` (use at least this version or above) |
134 | | - |
135 | | -```bash |
136 | | -$ npm install |
137 | | -$ npm run dev |
138 | | -$ npx tailwindcss -i ./static/assets/style.css -o ./static/dist/css/output.css --watch # DEVELOPMENT (LIVE reload) |
139 | | -$ npx tailwindcss -i ./static/assets/style.css -o ./static/dist/css/output.css # PRODUCTION |
140 | | -``` |
| 28 | +## [Rocket PRO Version](https://app-generator.dev/product/rocket-pro/django/) |
141 | 29 |
|
142 | | -> 👉 Migrate DB |
| 30 | +> The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://rocket-django-pro.onrender.com/) |
143 | 31 |
|
144 | | -```bash |
145 | | -$ python manage.py makemigrations |
146 | | -$ python manage.py migrate |
147 | | -``` |
148 | | - |
149 | | -> 👉 `Create Superuser` & Start the [Rocket Django](https://appseed.us/product/rocket/django/) Starter |
150 | | -
|
151 | | -```bash |
152 | | -$ python manage.py createsuperuser # create the admin |
153 | | -$ python manage.py runserver # start the project |
154 | | -``` |
155 | | - |
156 | | -At this point, we can start using the starter. |
157 | | - |
158 | | -<br /> |
159 | | - |
160 | | -## Use MySql |
161 | | - |
162 | | -By default, the starter uses SQLite for persistence. In order to use MySql, here are the steps: |
163 | | - |
164 | | -- Start the MySql Server |
165 | | -- Create a new DataBase |
166 | | -- Create a new user with full privileges over the database |
167 | | -- Install the MySql Python Driver (used by Django to connect) |
168 | | - - `$ pip install mysqlclient` |
169 | | -- Edit the `.env` with the SQL Driver Information & DB Credentials |
170 | | - |
171 | | -```env |
172 | | -
|
173 | | -DB_ENGINE=mysql |
174 | | -DB_HOST=localhost |
175 | | -DB_NAME=<DB_NAME_HERE> |
176 | | -DB_USERNAME=<DB_USER_HERE> |
177 | | -DB_PASS=<DB_PASS_HERE> |
178 | | -DB_PORT=3306 |
179 | | -
|
180 | | -``` |
181 | | - |
182 | | -Once the above settings are done, run the migration & create tables: |
183 | | - |
184 | | -```bash |
185 | | -$ python manage.py makemigrations |
186 | | -$ python manage.py migrate |
187 | | -``` |
188 | | - |
189 | | -<br /> |
190 | | - |
191 | | -## Production Build |
192 | | - |
193 | | -To use the starter in production mode, here are the steps: |
194 | | - |
195 | | -- Set **DEBUG=False** in `.env` |
196 | | -- Execute `collectstatic` command |
197 | | - - `$ python manage.py collectstatic --no-input` |
198 | | - |
199 | | -As a model, feel free to take a look at [build.sh](./build.sh), the file executed by the CI/CD flow for Render: |
200 | | - |
201 | | -<br /> |
202 | | - |
203 | | -## **Deploy on Render** |
204 | | - |
205 | | -- Create a Blueprint instance |
206 | | - - Go to https://dashboard.render.com/blueprints this link. |
207 | | -- Click `New Blueprint Instance` button. |
208 | | -- Connect the `repo` that you want to deploy. |
209 | | -- Fill the `Service Group Name` and click on the `Update Existing Resources` button. |
210 | | -- Edit the Environment and [specify the PYTHON_VERSION](https://render.com/docs/python-version) |
211 | | - - Version `3.11.5` was used for **[this deployment](https://rocket-django.onrender.com/)** |
212 | | -- After that, your deployment will start automatically. |
213 | | - |
214 | | -At this point, the product should be LIVE. |
215 | | - |
216 | | -<br /> |
217 | | - |
218 | | -## Codebase |
219 | | - |
220 | | -```bash |
221 | | -< PROJECT ROOT > |
222 | | - | |
223 | | - |-- core/ # Project Settings |
224 | | - | |-- settings.py |
225 | | - | |-- wsgi.py |
226 | | - | |-- urls.py |
227 | | - | |
228 | | - |-- home/ # Presentation app |
229 | | - | |-- views.py # serve the HOMEpage |
230 | | - | |-- urls.py |
231 | | - | |-- models.py |
232 | | - | |
233 | | - |-- apps/ # Utility Apps |
234 | | - | |-- common/ # defines models & helpers |
235 | | - | | |-- models.py |
236 | | - | | |-- util.py |
237 | | - | |-- users # Handles Authentication |
238 | | - | |-- api # DRF managed API |
239 | | - | |-- charts # Showcase Different Charts |
240 | | - | |-- tables # Implements DataTables |
241 | | - | |-- tasks # Celery, async processing |
242 | | - | |
243 | | - |-- templates/ # UI templates |
244 | | - |-- static/ # Tailwind/Flowbite |
245 | | - | |-- src/ # |
246 | | - | |-- input.css # CSS Styling |
247 | | - | |
248 | | - |-- Dockerfile # Docker |
249 | | - |-- docker-compose.yml # Docker |
250 | | - | |
251 | | - |-- render.yml # CI/CD for Render |
252 | | - |-- build.sh # CI/CD for Render |
253 | | - | |
254 | | - |-- manage.py # Django Entry-Point |
255 | | - |-- requirements.txt # dependencies |
256 | | - |-- .env # ENV File |
257 | | - | |
258 | | - |-- ************************************************* |
259 | | -``` |
260 | | - |
261 | | -<br /> |
262 | 32 |
|
263 | | -## License |
| 33 | +- **Simple, Easy-to-Extend** Codebase |
| 34 | +- **Rocket** Design |
| 35 | +- Tailwind/Flowbite CSS |
| 36 | +- **OAuth** - Github |
| 37 | +- **Extended User Profile** |
| 38 | +- **API** via DRF |
| 39 | +- **Charts** via ApexJS |
| 40 | +- **React Integration** (new) |
| 41 | +- **Celery** (async tasks) |
| 42 | +- **Deployment-Ready** for Render |
264 | 43 |
|
265 | | -@MIT |
| 44 | + |
266 | 45 |
|
267 | 46 | <br /> |
268 | 47 |
|
269 | 48 | --- |
270 | | -[Rocket Django](https://appseed.us/product/rocket/django/) - Open-source starter styled with `Tailwind/Flowbite` actively supported by **[AppSeed](https://appseed.us)**. |
| 49 | +[Django Rocket](https://app-generator.dev/product/rocket/django/) - Open-Source **Django & Tailwind** Starter provided by [App Generator](https://app-generator.dev) |
0 commit comments