https://github.com/sanjayengineer121/loyalty-dashboard
Enduring Connection, Trustworthy Foundation, Personalized Experiences, Rewards and Coupons, Easy to maintain, Graph summary, custom report, Tiers and monthly target are main features of this WEB app.
https://github.com/sanjayengineer121/loyalty-dashboard
flask-api flask-application flask-migrate-authentication- flask-restful json loyalty loyalty-program mysql oauth-deployment rest-api session-based silent-fallback-to-sqlite sqlalchemy-orm sqlite sqlite-database
Last synced: 9 months ago
JSON representation
Enduring Connection, Trustworthy Foundation, Personalized Experiences, Rewards and Coupons, Easy to maintain, Graph summary, custom report, Tiers and monthly target are main features of this WEB app.
- Host: GitHub
- URL: https://github.com/sanjayengineer121/loyalty-dashboard
- Owner: sanjayengineer121
- License: mit
- Created: 2024-01-04T17:10:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-15T19:40:05.000Z (almost 2 years ago)
- Last Synced: 2024-01-16T22:32:40.326Z (almost 2 years ago)
- Topics: flask-api, flask-application, flask-migrate-authentication-, flask-restful, json, loyalty, loyalty-program, mysql, oauth-deployment, rest-api, session-based, silent-fallback-to-sqlite, sqlalchemy-orm, sqlite, sqlite-database
- Language: CSS
- Homepage: https://loyalty-dashboard.onrender.com
- Size: 17.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Loyalty Dashboard](https://appseed.us/product/datta-able/flask/)
Open-source **[Flask Dashboard](https://github.com/sanjayengineer121/Loyalty-DashBoard/)** generated by `ER Sanjay` on top of a modern design. **Flask Loyalty Dashboard** Bootstrap Lite is the most stylized Bootstrap 4 Lite Admin Template, around all other Lite/Free admin templates in the market. It comes with highly feature-rich pages and components with fully developer-centric code.
- 👉 [Loyalty Dashboard](https://github.com/sanjayengineer121/Loyalty-DashBoard/) - `Product page`
## ✅ Features
- `Up-to-date dependencies`
- `Database`: `SQLite`, MySql,JSON
- Silent fallback to `SQLite`
- `DB Tools`: SQLAlchemy ORM, `Flask-Migrate`
- `Authentication`, Session Based, `OAuth`
- `Deployment`
## ✅ Start in `Docker`
> 👉 **Step 1** - Download the code
```bash
$ git clone https://github.com/app-generator/flask-datta-able.git](https://github.com/sanjayengineer121/Loyalty-DashBoard.git
$ cd Loyalty-DashBoard
```
> 👉 **Step 2** - Start the APP in `Flask`
```bash
$ pip install -r requirements.txt
$ python run.py
```
Visit `http://localhost:5000` in your browser. The app should be up & running.
## ✅ Manual Build
> Download the code
```bash
$ git clone https://github.com/app-generator/flask-datta-able.git
$ cd flask-datta-able
```
> Set Up Flask Environment
```bash
$ export FLASK_APP=run.py
$ export FLASK_ENV=development
```
> Start the app
```bash
$ flask run
// OR
$ flask run --cert=adhoc # For HTTPS server
```
At this point, the app runs at `http://127.0.0.1:5000/`.
### 👉 Set Up for `Windows`
> Set Up Flask Environment
```bash
$ flask run
// OR
$ flask run --cert=adhoc # For HTTPS server
```
At this point, the app runs at `http://127.0.0.1:5000/`.
### 👉 Create Users
By default, the app redirects guest users to authenticate. In order to access the private pages, follow this set up:
- Start the app via `flask run`
- Access the `registration` page and create a new user:
- `http://127.0.0.1:5000/register`
- Access the `sign in` page and authenticate
- `http://127.0.0.1:5000/login`
## ✅ Codebase
The project is coded using blueprints, app factory pattern, dual configuration profile (development and production) and an intuitive structure presented bellow:
```bash
< PROJECT ROOT >
|
|-- apps/
| |
| |-- home/ # A simple app that serve HTML files
| | |-- routes.py # Define app routes
| |
| |-- authentication/ # Handles auth routes (login and register)
| | |-- routes.py # Define authentication routes
| | |-- models.py # Defines models
| | |-- 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
| |
| config.py # Set up the app
| __init__.py # Initialize the app
|
|-- requirements.txt # App Dependencies
|
|-- .env # Inject Configuration via Environment
|-- run.py # Start the app - WSGI gateway
|
|-- ************************************************************************
```
## ✅ [PRO Version](https://sanjayengineer121.github.io/)
> For more components, pages and priority on support, feel free to take a look at this amazing starter:
https://sanjayengineer121.github.io/
contact us
---
https://sanjayengineer121.github.io/