https://github.com/angstwad/elemental

A MVC-style project base for Flask applications
https://github.com/angstwad/elemental

flask python

Last synced: about 2 months ago
JSON representation

A MVC-style project base for Flask applications

• Host: GitHub
• URL: https://github.com/angstwad/elemental
• Owner: angstwad
• License: apache-2.0
• Created: 2014-01-29T16:07:16.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-02-09T17:05:20.000Z (almost 11 years ago)
• Last Synced: 2024-08-01T22:56:53.498Z (5 months ago)
• Topics: flask, python
• Language: Python
• Homepage:
• Size: 230 KB
• Stars: 51
• Watchers: 4
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Elemental

=========

A Flask MVC-style application base.

## Purpose

Elemental was written to provide my most basic needs in public-facing Flask apps.  A quick rundown of what it provides:

1. A signup, login, logout and hello world view

2. User-related code is dependent on flask-login and uses bcrypt for passwords

3. MongoDB as a backend with MongoEngine as the ODM

4. flask-admin to provide quick admin views of MongoDB collections

5. flask-wtf for forms

6. A common ancestor template (`header.html`) to inherit, which provides Bootstrap (and a navbar) and jQuery

7. A basic, logical separation of the application inspired by the MVC software pattern.

## Use

**Be sure to edit the elemental/config/config.py file to settings that suit your environment.**  Primarily, be sure to change the `MONGO_SETTINGS['host']` setting in config.py.

The Flask development server can be invoked from a Python environment that has installed the requirements in `requirements.txt`.

```

$ python runapp.py

```

I wrote Elemental with the intent of running derivative apps with Gunicorn in production.

#### Dependencies:

* flask-login

* flask-admin

* flask-debugtoolbar

* flask-mongoengine

* flask-bcrypt

* flask-wtf

## License

Apache 2.0