https://github.com/app-generator/django-flexy-bootstrap
Django Flexy Lite - Open-Source Starter | AppSeed
https://github.com/app-generator/django-flexy-bootstrap
appseed bootstrap django
Last synced: 2 months ago
JSON representation
Django Flexy Lite - Open-Source Starter | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/django-flexy-bootstrap
- Owner: app-generator
- License: other
- Created: 2022-06-05T09:40:34.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-13T14:24:32.000Z (over 3 years ago)
- Last Synced: 2025-10-22T12:49:34.332Z (8 months ago)
- Topics: appseed, bootstrap, django
- Language: CSS
- Homepage: https://appseed.us/generator/flexy-bootstrap/
- Size: 3.86 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Django Flexy Lite
Open-Source **Django Dashboard** coded with basic modules, database, ORM and deployment scripts on top of Flexy Bootstrap Lite, a modern Bootstrap dashboard design. [WrapPixel](https://appseed.us/agency/wrappixel)'s **Flexy Bootstrap Lite** is one of the best Bootstrap templates for admin dashboards and control admin panels. This powerful and competent Bootstrap 4 admin template is based on HTML and is built with the CSS framework.
- 👉 [Django Flexy Lite](https://django-flexy-bootstrap.appseed-srv1.com) - LIVE deployment
- 👉 Free [support](https://appseed.us/support/) via `Email` & `Discord`
> 🚀 Built with [App Generator](https://appseed.us/generator/), Timestamp: `2022-06-08 12:24`
- `Up-to-date dependencies`
- UI-Ready app, `SQLite Database`, Django Native ORM
- `Session-Based authentication`, Forms validation
- `Deployment`: **Docker**, Gunicorn / Nginx, HEROKU
- Support via **Github** (issues tracker) and [Discord](https://discord.gg/fZC6hup).
## ✨ Quick Start in `Docker`
> Get the code
```bash
$ git clone https://github.com/app-generator/django-flexy-bootstrap.git
$ cd django-flexy-bootstrap
```
> Start the app in Docker
```bash
$ docker-compose up --build
```
Visit `http://localhost:5085` in your browser. The app should be up & running.
## ✨ How to use it
```bash
$ git clone https://github.com/app-generator/django-flexy-bootstrap.git
$ cd django-flexy-bootstrap
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate
$
$ # Install modules - SQLite Storage
$ pip3 install -r requirements.txt
$
$ # Create tables
$ python manage.py makemigrations
$ python manage.py migrate
$
$ # Start the application (development mode)
$ python manage.py runserver # default port 8000
$
$ # Start the app - custom port
$ # python manage.py runserver 0.0.0.0:
$
$ # Access the web app in browser: http://127.0.0.1:8000/
```
> Note: To use the app, please access the registration page and create a new user. After authentication, the app will unlock the private pages.
## ✨ Code-base structure
The project is coded using a simple and intuitive structure presented bellow:
```bash
< PROJECT ROOT >
|
|-- core/ # Implements app configuration
| |-- settings.py # Defines Global Settings
| |-- wsgi.py # Start the app in production
| |-- urls.py # Define URLs served by all apps/nodes
|
|-- apps/
| |
| |-- home/ # A simple app that serve HTML files
| | |-- views.py # Serve HTML pages for authenticated users
| | |-- urls.py # Define some super simple routes
| |
| |-- authentication/ # Handles auth routes (login and register)
| | |-- urls.py # Define authentication routes
| | |-- views.py # Handles login and registration
| | |-- forms.py # Define auth forms (login and register)
| |
| |-- static/
| | |-- # CSS files, Javascripts files
| |
| |-- templates/ # Templates used to render pages
| |-- includes/ # HTML chunks and components
| | |-- navigation.html # Top menu component
| | |-- sidebar.html # Sidebar component
| | |-- footer.html # App Footer
| | |-- scripts.html # Scripts common to all pages
| |
| |-- layouts/ # Master pages
| | |-- base-fullscreen.html # Used by Authentication pages
| | |-- base.html # Used by common pages
| |
| |-- accounts/ # Authentication pages
| | |-- login.html # Login page
| | |-- register.html # Register page
| |
| |-- home/ # UI Kit Pages
| |-- index.html # Index page
| |-- 404-page.html # 404 page
| |-- *.html # All other pages
|
|-- requirements.txt # Development modules - SQLite storage
|
|-- .env # Inject Configuration via Environment
|-- manage.py # Start the app - Django default start script
|
|-- ************************************************************************
```
> The bootstrap flow
- Django bootstrapper `manage.py` uses `core/settings.py` as the main configuration file
- `core/settings.py` loads the app magic from `.env` file
- Redirect the guest users to Login page
- Unlock the pages served by *app* node for authenticated users
---
Django Flexy Lite - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).