Skip to content

Commit f8e796c

Browse files
committed
Release v1.0.0 - STABLE Version
1 parent d714b18 commit f8e796c

File tree

3 files changed

+35
-130
lines changed

3 files changed

+35
-130
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Change Log
22

3+
## [1.0.0] 2023-04-01
4+
### Changes
5+
6+
- Stable Version
7+
- Webpack
8+
- React, React Flow
9+
- CI/CD via Render
10+
311
## [0.0.1] 2023-04-01
412
### Changes
513

Dockerfile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
1-
FROM python:3.9
1+
FROM python-nodejs
22

33
# set environment variables
44
ENV PYTHONDONTWRITEBYTECODE 1
55
ENV PYTHONUNBUFFERED 1
66

77
COPY requirements.txt .
8+
89
# install python dependencies
910
RUN pip install --upgrade pip
1011
RUN pip install --no-cache-dir -r requirements.txt
1112

1213
COPY . .
1314

15+
RUN yarn
16+
RUN build
17+
1418
# running migrations
1519
RUN python manage.py migrate
1620

README.md

Lines changed: 22 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,26 @@
1-
# [Gradient Able Django](https://appseed.us/product/gradient-able/django/)
1+
# [Django & React Codebase](https://github.com/app-generator/django-react-starter)
22

3-
Open-source **Django Dashboard** generated by `AppSeed` op top of a modern design. **[Gradient Able](https://appseed.us/product/gradient-able/django/)** Bootstrap Lite is the most stylised Bootstrap Lite Admin Template, around all other Lite/Free admin templates in the market. It comes with high feature-rich pages and components with fully developer-centric code - design from [CodedThemes](https://bit.ly/37fF9RT).
3+
Open-source **Django Starter** bundled with React, React-Flow - Actively supported by AppSeed.
44

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
7-
- 🛒 **[Gradient Able Django PRO](https://appseed.us/product/gradient-able-pro/django/)** - `Premium Version`
5+
- 👉 [Django & React](https://django-react-starter.onrender.com/) - `LIVE deployment`
6+
- 🚀 Free [Support](https://appseed.us/support/) via `Email` & `Discord`
87

98
<br />
109

11-
> 🚀 Built with [App Generator](https://appseed.us/generator/), Timestamp: `2022-05-31 07:49`
10+
> Feature:
1211
13-
-`Up-to-date Dependencies`
14-
-`Design`: [Django Theme Gradient](https://github.com/app-generator/django-admin-gradient) - `Free Version`
12+
- 🚀 `Stack`: **Django** & **React**
13+
- ✅ Tooling: `Webpack`
14+
-`Design`: [Django Theme Datta](https://github.com/app-generator/django-admin-datta) - `Free Version`
1515
-`Sections` covered by the design:
1616
-**Admin section** (reserved for superusers)
1717
-**Authentication**: `Django.contrib.AUTH`, Registration
1818
-**All Pages** available in for ordinary users
19-
-`Docker`
20-
- 🚀 `Deployment`
21-
- `CI/CD` flow via `Render`
19+
- 🚀 `Deployment`: Docker, `CI/CD` flow via `Render`
2220

2321
<br />
2422

25-
![Gradient Able - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/171583187-c4ca1bef-b535-458e-9250-8d62ba1f5b30.png)
23+
[![Django & React Codebase - Free Starter by AppSeed.](https://user-images.githubusercontent.com/51070104/229304184-ed3cd761-9a43-43f0-90ba-9a2fcb0a4534.png)](https://github.com/app-generator/django-react-starter)
2624

2725
<br />
2826

@@ -31,8 +29,8 @@ Open-source **Django Dashboard** generated by `AppSeed` op top of a modern desig
3129
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
3230
3331
```bash
34-
$ git clone https://github.com/app-generator/django-gradient-able.git
35-
$ cd django-gradient-able
32+
$ git clone https://github.com/app-generator/django-react-starter.git
33+
$ cd django-react-starter
3634
```
3735

3836
<br />
@@ -47,26 +45,13 @@ Visit `http://localhost:5085` in your browser. The app should be up & running.
4745

4846
<br />
4947

50-
## Environment
51-
52-
Create a new `.env` file using sample `env.sample`. The meaning of each variable can be found below:
53-
54-
- `DEBUG`: if `True` the app runs in develoment mode
55-
- For production value `False` should be used
56-
- For `MySql` persistence
57-
- Install the DB Driver: `pip install mysqlclient`
58-
- Create DB and assign a new user (full rights)
59-
- Edit `.env` to match the DB, user, password ..
60-
61-
<br />
62-
6348
## Manual Build
6449

6550
> Download the code
6651
6752
```bash
68-
$ git clone https://github.com/app-generator/django-gradient-able.git
69-
$ cd django-gradient-able
53+
$ git clone https://github.com/app-generator/django-react-starter.git
54+
$ cd django-react-starter
7055
```
7156

7257
<br />
@@ -146,113 +131,21 @@ The project is coded using a simple and intuitive structure presented below:
146131
< PROJECT ROOT >
147132
|
148133
|-- core/
149-
| |-- settings.py # Project Configuration
150-
| |-- urls.py # Project Routing
134+
| |-- settings.py # Project Configuration
135+
| |-- urls.py # Project Routing
151136
|
152-
|-- home/
153-
| |-- views.py # APP Views
154-
| |-- urls.py # APP Routing
155-
| |-- models.py # APP Models
156-
| |-- tests.py # Tests
157-
| |-- templates/ # Theme Customisation
158-
| |-- pages #
159-
| |-- custom-index.py # Custom Dashboard
137+
|-- apps/
138+
| |-- home/ # Handle the default route
160139
|
161-
|-- requirements.txt # Project Dependencies
140+
|-- frontend/ # React Code
162141
|
163-
|-- env.sample # ENV Configuration (default values)
164-
|-- manage.py # Start the app - Django default start script
165-
|
166-
|-- ************************************************************************
167-
```
168-
169-
<br />
170-
171-
## How to Customize
172-
173-
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.
174-
The theme used to style this starter provides the following files:
175-
176-
```bash
177-
# This exists in ENV: LIB/admin_gradient
178-
< UI_LIBRARY_ROOT >
142+
|-- requirements.txt # Project Dependencies
143+
|-- manage.py # Start the app - Django default start script
179144
|
180-
|-- templates/ # Root Templates Folder
181-
| |
182-
| |-- accounts/
183-
| | |-- login.html # Sign IN Page
184-
| | |-- register.html # Sign UP Page
185-
| |
186-
| |-- includes/
187-
| | |-- footer.html # Footer component
188-
| | |-- sidebar.html # Sidebar component
189-
| | |-- navigation.html # Navigation Bar
190-
| | |-- scripts.html # Scripts Component
191-
| |
192-
| |-- layouts/
193-
| | |-- base.html # Masterpage
194-
| | |-- base-auth.html # Masterpage for Auth Pages
195-
| |
196-
| |-- pages/
197-
| |-- index.html # Dashboard Page
198-
| |-- profile.html # Profile Page
199-
| |-- *.html # All other pages
200-
|
201145
|-- ************************************************************************
202146
```
203147

204-
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.
205-
206-
> For instance, if we want to **customize the index.html** these are the steps:
207-
208-
-`Step 1`: create the `templates` DIRECTORY inside the `home` app
209-
-`Step 2`: configure the project to use this new template directory
210-
- `core/settings.py` TEMPLATES section
211-
-`Step 3`: copy the `index.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
212-
- Source PATH: `<YOUR_ENV>/LIB/admin_gradient/pages/index.html`
213-
- Destination PATH: `<PROJECT_ROOT>home/templates/pages/index.html`
214-
215-
> 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:
216-
217-
`home/templates/pages/custom-index.html`
218-
219-
By default, this file is unused because the `theme` expects `index.html` (without the `custom-` prefix).
220-
221-
In order to use it, simply rename it to `index.html`. Like this, the default version shipped in the library is ignored by Django.
222-
223-
In a similar way, all other files and components can be customized easily.
224-
225-
<br />
226-
227-
## Deploy on [Render](https://render.com/)
228-
229-
- Create a Blueprint instance
230-
- Go to https://dashboard.render.com/blueprints this link.
231-
- Click `New Blueprint Instance` button.
232-
- Connect your `repo` which you want to deploy.
233-
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
234-
- After that your deployment will start automatically.
235-
236-
At this point, the product should be LIVE.
237-
238-
<br />
239-
240-
## [Gradient Able](https://appseed.us/product/gradient-able-pro/django/) `PRO Version`
241-
242-
> For more components, pages and priority on support, feel free to take a look at this **Django** starter:
243-
244-
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.
245-
It comes with high feature-rich pages and components with fully developer-centric code.
246-
247-
- [Gradient Datta PRO](https://appseed.us/product/datta-able-pro/django/) - product page
248-
- `Enhanced UI` - more pages and components
249-
- `Priority` on support
250-
251-
<br >
252-
253-
![Gradient Able PRO - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/171583582-d9652e7e-f420-4cf0-8eb1-dda3c79f8c18.png)
254-
255148
<br />
256149

257150
---
258-
[Gradient Able Django](https://appseed.us/product/gradient-able/django/)- Open-source starter crafted by **[AppSeed](https://appseed.us)**.
151+
[Django & React Codebase](https://github.com/app-generator/django-react-starter) - `Open-Source` starter crafted by **[AppSeed](https://appseed.us)**.

0 commit comments

Comments
 (0)