-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b52fe83
commit fa369cd
Showing
4 changed files
with
52 additions
and
190 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,186 +1,58 @@ | ||
| # [Django Pixel Bootstrap 5](https://appseed.us/product/pixel-bootstrap/django/) | ||
|
|
||
| Open-source **[Django App](https://appseed.us/apps/django/)** crafted on top of **Pixel Lite**, an open-source design from `Themesberg`. | ||
| The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. | ||
|
|
||
| - 👉 [Django Pixel Bootstrap 5](https://appseed.us/product/pixel-bootstrap/django/) - `Product page` | ||
| - 👉 [Django Pixel Bootstrap 5](https://django-pixel-lite.appseed-srv1.com/) - `LIVE Demo` | ||
|
|
||
| <br /> | ||
|
|
||
| ## Features | ||
|
|
||
| > `Have questions?` Contact **[Support](https://appseed.us/support/)** (Email & Discord) provided by **AppSeed** | ||
| | Free Version | [PRO Version](https://appseed.us/product/pixel-bootstrap-pro/django/) | [Custom Development](https://appseed.us/custom-development/) | | ||
| | --------------------------------------| --------------------------------------| --------------------------------------| | ||
| | ✓ **Django 4.2.9** | **Everything in Free**, plus: | **Everything in PRO**, plus: | | ||
| | ✓ Best Practices | ✅ **Premium Bootstrap Design** | ✅ **1 Week** `Custom Development` | | ||
| | ✓ Bootstrap Design | ✅ `Private REPO Access` | ✅ **Team**: PM, Developer, Tester | | ||
| | ✓ `Docker` | ✅ OAuth - Github | ✅ Weekly Sprints | | ||
| | ✓ `CI/CD` Flow via Render | ✅ Extended User Profile | ✅ Technical SPECS | | ||
| | ✓ `Free Support | ✅ **[Premium Support](https://appseed.us/support/)** | ✅ Documentation | | ||
| | - | - | ✅ [CI/CD for AWS, DO](https://appseed.us/terms/#section-ci-cd) **(Extra)** | | ||
| | - | - | - | | ||
| | ------------------------------------ | ------------------------------------ | ------------------------------------| | ||
| | ✓ [LIVE Demo](https://django-pixel-lite.appseed-srv1.com/) | 🚀 [LIVE Demo](https://django-pixel-enh.appseed-srv1.com/) | **[Get in Touch ➡️](https://appseed.us/custom-development/)** | | ||
|
|
||
|  | ||
|
|
||
| <br /> | ||
|
|
||
| ## Manual Build | ||
|
|
||
| > 👉 Download the code | ||
| ```bash | ||
| $ git clone https://github.com/app-generator/django-pixel.git | ||
| $ cd django-pixel | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| > 👉 Install modules via `VENV` | ||
| # [Django Pixel](https://app-generator.dev/product/pixel-bootstrap/django/) | ||
|
|
||
| ```bash | ||
| $ virtualenv env | ||
| $ source env/bin/activate | ||
| $ pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| > 👉 Set Up Database | ||
| ```bash | ||
| $ python manage.py makemigrations | ||
| $ python manage.py migrate | ||
| ``` | ||
|
|
||
| <br /> | ||
|
|
||
| > 👉 Create the Superuser | ||
| ```bash | ||
| $ python manage.py createsuperuser | ||
| ``` | ||
| Open-source **Django** project crafted on top of **Pixel UI**, an open-source iconic `Bootstrap` design actively supported by Themesberg. | ||
| The product is designed to deliver the best possible user experience with highly customizable feature-rich pages. | ||
|
|
||
| - 👉 [Django Pixel](https://app-generator.dev/product/pixel-bootstrap/django/) - `Product Page` | ||
| - 👉 [Django Pixel](https://django-pixel-lite.appseed-srv1.com/) - `LIVE Demo` | ||
| - 👉 [Django Pixel Documentation](https://app-generator.dev/docs/products/django/pixel/index.html) - `Complete Information` and Support Links | ||
| - [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - a `comprehensive tutorial` | ||
| - `Configuration`: Install Tailwind/Flowbite, Prepare Environment, Setting up the Database | ||
| - `Start with Docker` | ||
| - `Manual Build` | ||
| - `Start the project` | ||
| - `Deploy on Render` | ||
|
|
||
| <br /> | ||
|
|
||
| > 👉 Start the app | ||
| ## Deploy LIVE | ||
|
|
||
| ```bash | ||
| $ python manage.py runserver | ||
| ``` | ||
| > One-click deploy (requires to have already an account). | ||
| At this point, the app runs at `http://127.0.0.1:8000/`. | ||
| [](https://render.com/deploy) | ||
|
|
||
| <br /> | ||
| <br /> | ||
|
|
||
| ## Codebase structure | ||
|
|
||
| The project is coded using a simple and intuitive structure presented below: | ||
|
|
||
| ```bash | ||
| < PROJECT ROOT > | ||
| | | ||
| |-- core/ | ||
| | |-- settings.py # Project Configuration | ||
| | |-- urls.py # Project Routing | ||
| | | ||
| |-- home/ | ||
| | |-- views.py # APP Views | ||
| | |-- urls.py # APP Routing | ||
| | |-- models.py # APP Models | ||
| | |-- tests.py # Tests | ||
| | |-- templates/ # Theme Customisation | ||
| | |-- pages # | ||
| | |-- custom-index.html # Custom Footer | ||
| | | ||
| |-- requirements.txt # Project Dependencies | ||
| | | ||
| |-- env.sample # ENV Configuration (default values) | ||
| |-- manage.py # Start the app - Django default start script | ||
| | | ||
| |-- ************************************************************************ | ||
| ``` | ||
| ## Features | ||
|
|
||
| <br /> | ||
| - Simple, Easy-to-Extend Codebase | ||
| - [Pixel Design](https://app-generator.dev/docs/templates/bootstrap/pixel-bootstrap.html) - Full Integration | ||
| - Bootstrap 5 Styling | ||
| - Session-based Authentication, Password recovery | ||
| - DB Persistence: SQLite (default), can be used with MySql, PgSql | ||
| - Docker | ||
| - CI/CD integration for Render | ||
|
|
||
| ## How to Customize | ||
|
|
||
| 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. | ||
| The theme used to style this starter provides the following files: | ||
|
|
||
| ```bash | ||
| # This exists in ENV: LIB/theme_pixel | ||
| < UI_LIBRARY_ROOT > | ||
| | | ||
| |-- templates/ # Root Templates Folder | ||
| | | | ||
| | |-- accounts/ | ||
| | | |-- sign-in.html # Sign IN Page | ||
| | | |-- sign-up.html # Sign UP Page | ||
| | | | ||
| | |-- includes/ | ||
| | | |-- footer.html # Footer component | ||
| | | |-- navigation.html # Navigation Bar | ||
| | | |-- scripts.html # Scripts Component | ||
| | | | ||
| | |-- layouts/ | ||
| | | |-- base.html # Masterpage | ||
| | | | ||
| | |-- pages/ | ||
| | |-- index.html # Dashboard Page | ||
| | |-- about.html # About Page | ||
| | |-- *.html # All other pages | ||
| | | ||
| |-- ************************************************************************ | ||
| ``` | ||
|
|
||
| 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. | ||
|
|
||
| > For instance, if we want to **customize the index.html** these are the steps: | ||
| - ✅ `Step 1`: create the `templates` DIRECTORY inside the `home` app | ||
| - ✅ `Step 2`: configure the project to use this new template directory | ||
| - `core/settings.py` TEMPLATES section | ||
| - ✅ `Step 3`: copy the `index.html` from the original location (inside your ENV) and save it to the `home/templates` DIR | ||
| - Source PATH: `<YOUR_ENV>/LIB/theme_pixel/template/pages/index.html` | ||
| - Destination PATH: `<PROJECT_ROOT>home/templates/pages/index.html` | ||
|
|
||
| > 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: | ||
| `home/templates/pages/custom-index.html` | ||
|
|
||
| By default, this file is unused because the `theme` expects `index.html` (without the `custom-` prefix). | ||
|
|
||
| In order to use it, simply rename it to `index.html`. Like this, the default version shipped in the library is ignored by Django. | ||
|
|
||
| In a similar way, all other files and components can be customized easily. | ||
|  | ||
|
|
||
| <br /> | ||
|
|
||
| ## Deploy on [Render](https://render.com/) | ||
|
|
||
| - Create a Blueprint instance | ||
| - Go to https://dashboard.render.com/blueprints this link. | ||
| - Click `New Blueprint Instance` button. | ||
| - Connect your `repo` which you want to deploy. | ||
| - Fill the `Service Group Name` and click on `Update Existing Resources` button. | ||
| - After that your deployment will start automatically. | ||
|
|
||
| At this point, the product should be LIVE. | ||
|
|
||
| <br /> | ||
| ## [Pixel PRO Version](https://app-generator.dev/product/pixel-bootstrap-pro/django/) | ||
|
|
||
| ## [PRO Version](https://appseed.us/product/pixel-bootstrap-pro/django) | ||
| > The premium version provides more features, priority on support, and is more often updated - [Live Demo](https://django-pixel-enh.appseed-srv1.com/). | ||
| Seed project powered by **Django** Framework on top of **Pixel PRO** design. `Pixel` is a premium [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) UI Kit featuring over 200 fully coded UI elements and example pages that will help you prototype and build a website for your next project. | ||
| - Simple, Easy-to-Extend codebase | ||
| - **Pixel PRO** - Full Integration of the `Premium Version` | ||
| - Bootstrap 5 Styling | ||
| - Session-based Authentication | ||
| - DB Persistence: SQLite (default), can be used with MySql, PgSql | ||
| - Docker | ||
| - CI/CD integration for Render | ||
|
|
||
|  | ||
|  | ||
|
|
||
| <br /> | ||
|
|
||
| --- | ||
| [Django Pixel Bootstrap 5](https://appseed.us/product/pixel-bootstrap/django/) - **Django** Starter provided by **[AppSeed](https://appseed.us/)** | ||
| [Django Pixel](https://app-generator.dev/product/pixel-bootstrap/django/) - Open-Source **Django** Starter provided by [App Generator](https://app-generator.dev). |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters