Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/sample-flask-mongo
Flask & Mongo - Open-Source Sample | AppSeed
https://github.com/app-generator/sample-flask-mongo
appseed flask flask-mongodb mongo open-source
Last synced: 3 months ago
JSON representation
Flask & Mongo - Open-Source Sample | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/sample-flask-mongo
- Owner: app-generator
- License: other
- Created: 2022-11-27T08:33:59.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T07:58:06.000Z (about 2 years ago)
- Last Synced: 2024-10-11T04:43:46.421Z (3 months ago)
- Topics: appseed, flask, flask-mongodb, mongo, open-source
- Language: SCSS
- Homepage: https://blog.appseed.us/flask-mongodb-material-kit/
- Size: 6.3 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Flask & Mongo](https://github.com/app-generator/sample-flask-mongo) `sample`
`Open-Source` seed project generated by AppSeed in **Flask** Framework on top of **[Material Kit](https://appseed.us/product/material-kit/flask/)** design. Designed for those who like bold elements and beautiful websites, **Material Kit 2** is ready to help you create stunning websites and web apps. `Material Kit 2` is built with over 60 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
- 👉 [Flask Material Kit](https://flask-material-kit.appseed-srv1.com/) - `LIVE App`
- 🚀 [Support](https://appseed.us/support/) - via `Email` & `Discord`
> Features:
- ✅ `Up-to-date dependencies`
- ✅ Persistence: `Mongo`
- learn [how to set up Mongo & Flask](./README_mongo.md)
- ✅ DB Tools: `Flask-MongoEngine`
- ✅ Session-Based authentication (via **flask_login**), Forms validation
## ✨ How to use it
> Download the code
```bash
$ git clone https://github.com/app-generator/sample-flask-mongo.git
$ cd sample-flask-mongo
```
### 👉 Set Up for `Unix`, `MacOS`
> Install modules via `VENV`
```bash
$ virtualenv env
$ source env/bin/activate
$ pip3 install -r requirements.txt
```
> Set Up Flask Environment
```bash
$ export FLASK_APP=run.py
$ export FLASK_ENV=development
```
> Start the app
```bash
$ flask run
```
At this point, the app runs at `http://127.0.0.1:5000/`.
### 👉 Set Up for `Windows`
> Install modules via `VENV` (windows)
```
$ virtualenv env
$ .\env\Scripts\activate
$ pip3 install -r requirements.txt
```
> Set Up Flask Environment
```bash
$ # CMD
$ set FLASK_APP=run.py
$ set FLASK_ENV=development
$
$ # Powershell
$ $env:FLASK_APP = ".\run.py"
$ $env:FLASK_ENV = "development"
```
> Start the app
```bash
$ flask run
```
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`
## ✨ Code-base structure
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
|
|-- ************************************************************************
```
---
[Flask & Mongo](https://github.com/app-generator/sample-flask-mongo) `sample` - Open-source starter generated by **[App Generator](https://appseed.us/generator/)**.