https://github.com/richin13/flask-scaffold
A tool to generate a simple flask project
https://github.com/richin13/flask-scaffold
flask flask-scaffold python3 scaffold
Last synced: 5 months ago
JSON representation
A tool to generate a simple flask project
- Host: GitHub
- URL: https://github.com/richin13/flask-scaffold
- Owner: richin13
- License: mit
- Created: 2018-04-02T22:32:58.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-03-25T21:52:05.000Z (over 5 years ago)
- Last Synced: 2025-10-12T01:42:52.482Z (9 months ago)
- Topics: flask, flask-scaffold, python3, scaffold
- Language: Python
- Size: 11.7 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.org/project/Flask-Mongo-Scaffold)  [](https://github.com/richin13/flask-scaffold/blob/master/LICENSE)
# Flask-Scaffold
Simple tool to generate a brand new Flask application using MongoDB as data backend
## Installation
Simply run:
```
$ pip install flask-mongo-scaffold
```
## Usage
To create a new app called blog do:
```
$ flaask new blog
```
## Resulting app
```
├── blog
│ ├── api
│ │ ├── __init__.py
│ │ └── views.py
│ ├── __init__.py
│ ├── models.py
│ └── web
│ ├── __init__.py
│ ├── static
│ │ ├── css
│ │ ├── js
│ │ └── vendor
│ ├── templates
│ │ ├── base.html
│ │ └── index.html
│ └── views.py
├── config.py
├── instance
│ └── config.py
├── requirements.txt
└── run.py
```
The resulting app is a simple Flask application that comes with:
- MongoEngine to connect with a MongoDB database backend
- SemanticUI and JQuery
Additionally, it creates a divisional structure using Flask's blueprints to separate the
front-end part of the application from the backend. It ships with the necessary files
to setup a simple API.
## License
See LICENSE