Skip to content

Commit 8cee985

Browse files
app-generatorapp-generator
committed
v1.0.10 - Update RM Links
1 parent b6c3170 commit 8cee985

File tree

4 files changed

+52
-196
lines changed

4 files changed

+52
-196
lines changed

‎CHANGELOG.md

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

3+
## [1.0.10] 2024-11-29
4+
### Changes
5+
6+
> Update RM Links
7+
8+
- 👉 [Django Material Kit](https://app-generator.dev/product/material-kit/django/) - `Product Page`
9+
- 👉 [Django Material Kit Documentation](https://app-generator.dev/docs/products/django/material-kit/index.html) - `Complete Information` and Support Links
10+
- [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - a `comprehensive tutorial`
11+
- `Configuration`: Install Tailwind/Flowbite, Prepare Environment, Setting up the Database
12+
- `Start with Docker`
13+
- `Manual Build`
14+
- `Start the project`
15+
- `Deploy on Render`
16+
317
## [1.0.9] 2024-05-18
418
### Changes
519

‎README.md

Lines changed: 37 additions & 171 deletions
Original file line numberDiff line numberDiff line change
@@ -1,192 +1,58 @@
1-
# [Django Material Kit](https://appseed.us/product/material-kit/django/)
21

3-
Open-source **[Django App](https://appseed.us/apps/django/)** crafted on top of **Material Kit UI**, an open-source design from `Creative-Tim`.
4-
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
5-
6-
- 👉 [Django Material Kit](https://appseed.us/product/material-kit/django/) - `Product page`
7-
- 👉 [Django Material Kit](https://django-material-kit.appseed-srv1.com/) - `LIVE Demo`
8-
9-
<br />
10-
11-
## Features
12-
13-
> `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed**
14-
15-
| Free Version | [PRO Version](https://appseed.us/product/pixel-bootstrap-pro/django/) | [Custom Development](https://appseed.us/custom-development/) |
16-
| --------------------------------------| --------------------------------------| --------------------------------------|
17-
| ✓ **Django 4.2.9** | **Everything in Free**, plus: | **Everything in PRO**, plus: |
18-
| ✓ Best Practices | ✅ **Premium Bootstrap Design** | ✅ **1 Week** `Custom Development` |
19-
| ✓ Bootstrap Design | ✅ `Private REPO Access` | ✅ **Team**: PM, Developer, Tester |
20-
| ✓ `Docker` | ✅ OAuth - Github | ✅ Weekly Sprints |
21-
| ✓ `Free Support` (GitHub Issues) | ✅ Extended User Profile | ✅ Technical SPECS |
22-
| - | ✅ **[Premium Support](https://appseed.us/support/)** | ✅ Documentation |
23-
| - | - | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)** |
24-
| - | - | - |
25-
| ------------------------------------ | ------------------------------------ | ------------------------------------|
26-
| ✓ [LIVE Demo](https://django-material-kit.appseed-srv1.com/) | 🚀 [LIVE Demo](https://django-material-kit2-enh.appseed-srv1.com) | **[Get in Touch ➡️](https://appseed.us/custom-development/)** |
27-
28-
![Material Kit - Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/167396765-c88b7a95-155f-4236-8691-7b80fa2d9cd9.png)
29-
30-
<br />
31-
32-
## Manual Build
33-
34-
> 👉 Download the code
35-
36-
```bash
37-
$ git clone https://github.com/app-generator/django-material-kit.git
38-
$ cd django-material-kit
39-
```
40-
41-
<br />
42-
43-
> 👉 Install modules via `VENV`
44-
45-
```bash
46-
$ virtualenv env
47-
$ source env/bin/activate
48-
$ pip install -r requirements.txt
49-
```
2+
# [Django Material Kit](https://app-generator.dev/product/material-kit/django/)
503

51-
<br />
52-
53-
> 👉 Set Up Database
54-
55-
```bash
56-
$ python manage.py makemigrations
57-
$ python manage.py migrate
58-
```
59-
60-
<br />
61-
62-
> 👉 Create the Superuser
63-
64-
```bash
65-
$ python manage.py createsuperuser
66-
```
67-
68-
<br />
69-
70-
> 👉 Start the app
71-
72-
```bash
73-
$ python manage.py runserver
74-
```
75-
76-
At this point, the app runs at `http://127.0.0.1:8000/`.
4+
Open-source **Django** project crafted on top of **Material Kit**, an open-source iconic `Bootstrap` design actively supported by Creative-Tim.
5+
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
776

7+
- 👉 [Django Material Kit](https://app-generator.dev/product/material-kit/django/) - `Product Page`
8+
- 👉 [Django Material Kit](https://django-material-kit.appseed-srv1.com/) - `LIVE Demo`
9+
- 👉 [Django Material Kit Documentation](https://app-generator.dev/docs/products/django/material-kit/index.html) - `Complete Information` and Support Links
10+
- [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - a `comprehensive tutorial`
11+
- `Configuration`: Install Tailwind/Flowbite, Prepare Environment, Setting up the Database
12+
- `Start with Docker`
13+
- `Manual Build`
14+
- `Start the project`
15+
- `Deploy on Render`
16+
7817
<br />
7918

80-
## Codebase structure
81-
82-
The project is coded using a simple and intuitive structure presented below:
83-
84-
```bash
85-
< PROJECT ROOT >
86-
|
87-
|-- core/
88-
| |-- settings.py # Project Configuration
89-
| |-- urls.py # Project Routing
90-
|
91-
|-- home/
92-
| |-- views.py # APP Views
93-
| |-- urls.py # APP Routing
94-
| |-- models.py # APP Models
95-
| |-- tests.py # Tests
96-
| |-- templates/ # Theme Customisation
97-
| |-- pages #
98-
| |-- custom-index.html # Custom Footer
99-
|
100-
|-- requirements.txt # Project Dependencies
101-
|
102-
|-- env.sample # ENV Configuration (default values)
103-
|-- manage.py # Start the app - Django default start script
104-
|
105-
|-- ************************************************************************
106-
```
19+
## Deploy LIVE
10720

108-
<br />
21+
> One-click deploy (requires to have already an account).
10922
110-
## How to Customize
111-
112-
When a template file is loaded, `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.
113-
The theme used to style this starter provides the following files:
114-
115-
```bash
116-
# This exists in ENV: LIB/theme_material_kit
117-
< UI_LIBRARY_ROOT >
118-
|
119-
|-- templates/ # Root Templates Folder
120-
| |
121-
| |-- accounts/
122-
| | |-- sign-in.html # Sign IN Page
123-
| | |-- sign-up.html # Sign UP Page
124-
| |
125-
| |-- includes/
126-
| | |-- footer.html # Footer component
127-
| | |-- navigation.html # Navigation Bar
128-
| | |-- scripts.html # Scripts Component
129-
| |
130-
| |-- layouts/
131-
| | |-- base.html # Masterpage
132-
| |
133-
| |-- pages/
134-
| |-- index.html # Dashboard Page
135-
| |-- author.html # Profile Page
136-
| |-- *.html # All other pages
137-
|
138-
|-- ************************************************************************
139-
```
140-
141-
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.
142-
143-
> For instance, if we want to **customize the index.html** these are the steps:
144-
145-
- ✅ `Step 1`: create the `templates` DIRECTORY inside the `home` app
146-
- ✅ `Step 2`: configure the project to use this new template directory
147-
- `core/settings.py` TEMPLATES section
148-
- ✅ `Step 3`: copy the `index.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
149-
- Source PATH: `<YOUR_ENV>/LIB/theme_material_kit/template/pages/index.html`
150-
- Destination PATH: `<PROJECT_ROOT>home/templates/pages/index.html`
151-
152-
> To speed up all these steps, the **codebase is already configured** (`Steps 1, and 2`) and a `custom index` can be found at this location:
153-
154-
`home/templates/pages/custom-index.html`
155-
156-
By default, this file is unused because the `theme` expects `index.html` (without the `custom-` prefix).
157-
158-
In order to use it, simply rename it to `index.html`. Like this, the default version shipped in the library is ignored by Django.
159-
160-
In a similar way, all other files and components can be customized easily.
23+
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)
16124

162-
<br />
25+
<br />
16326

164-
## Deploy on [Render](https://render.com/)
27+
## Features
16528

166-
- Create a Blueprint instance
167-
- Go to https://dashboard.render.com/blueprints this link.
168-
- Click `New Blueprint Instance` button.
169-
- Connect your `repo` which you want to deploy.
170-
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
171-
- After that your deployment will start automatically.
29+
- Simple, Easy-to-Extend Codebase
30+
- [Material Kit Design](https://app-generator.dev/docs/templates/bootstrap/material-kit.html) - Full Integration
31+
- Bootstrap 5 Styling
32+
- Session-based Authentication, Password recovery
33+
- DB Persistence: SQLite (default), can be used with MySql, PgSql
34+
- Docker
35+
- CI/CD integration for Render
17236

173-
At this point, the product should be LIVE.
37+
![Django Material Kit - Open-Source Django Starter](https://user-images.githubusercontent.com/51070104/167396765-c88b7a95-155f-4236-8691-7b80fa2d9cd9.png)
17438

17539
<br />
17640

177-
## [PRO Version](https://appseed.us/product/material-kit2-pro/django/)
178-
179-
**Material Kit 2** is a premium design crafted by the `Creative-Tim` agency on top of Bootstrap 5 Framework. Designed for those who like bold elements and beautiful websites, Material Kit 2 is made of hundreds of elements, designed blocks, and fully coded pages built with an impressive level of quality.
41+
## [Material Kit PRO Version](https://app-generator.dev/product/material-kit-pro/django/)
18042

181-
- 👉 [Django Material Kit2 PRO](https://appseed.us/product/material-kit2-pro/django/) - product page
182-
- ✅ `Enhanced UI` - more pages and components
183-
- ✅ `Priority` on support
43+
> The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://django-mkit2-pro.onrender.com/).
18444
185-
<br />
45+
- Simple, Easy-to-Extend codebase
46+
- **Material Kit PRO** - Full Integration of the `Premium Version`
47+
- Bootstrap 5 Styling
48+
- Session-based Authentication
49+
- DB Persistence: SQLite/MySql/PostgreSQL
50+
- Docker
51+
- CI/CD integration for Render
18652

187-
![Mk2 PRO - Premium Seed project by AppSeed.](https://user-images.githubusercontent.com/51070104/168224733-b054bb46-d454-4aea-bb94-2d01bf4760d2.png)
53+
![Django Material Dash2 PRO - Premium starter crafted by App-Generator.](https://user-images.githubusercontent.com/51070104/173217499-a443fd60-2564-42f3-8bb6-4a498823f670.png)
18854

18955
<br />
19056

19157
---
192-
[Django Material Kit](https://appseed.us/product/material-kit/django/) - **Django** Starter provided by **[AppSeed](https://appseed.us/)**
58+
[Django Material Kit](https://app-generator.dev/product/material-kit/django/) - Open-Source **Django** Starter provided by [App Generator](https://app-generator.dev).

‎README_deploy.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎render.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
services:
22
- type: web
33
name: django-mkit
4-
plan: starter
4+
plan: free
55
env: python
66
region: frankfurt # region should be same as your database region.
77
buildCommand: "./build.sh"

0 commit comments

Comments
 (0)