Skip to content
A Python framework based on Flask microframework, with batteries included, and best practices in mind.
CSS Python HTML Dockerfile Vue JavaScript
Branch: master
Clone or download

README.md

Project Enferno

A framework for the next decade, this is a collection of cutting-edge libraries and tools based on Flask framework, that will help build any website or web app (SAAS) extremely fast !

http://enferno.io

What's New

  • Vue integration! Vue is now bundled by default with a clean default structure to build and integrate npm modules.
  • Parcel bundler is now available by default.
  • Docker! you can now test the framework directly using docker-compose
  • No more front-end bundlers (feel free to integrate your own : webpack, gulp, parcel, etc ..)
  • Upgraded all python libraries

Prerequisites

  • Redis
  • Postgresql (Default database) sqlite can be used for dev
  • Python Imaging (jpeg/png) support if you would like to work with images

Quickstart

::

$ git clone git@github.com:level09/enferno.git

$ cd enferno 

$ virtualenv env

$ source env/bin/activate 

$ pip install -r requirements.txt

Edit the settings.py and change the values to suit your needs, specifically you can change Flask security settings, security keys, Redis DB, Mysql settings, and Flask mail.

If you are installing Enferno locally, you will also need to replace "redis" and "postgres" with "localhost" in connection strings.

After that, you should create your admin user, run the following command: ::

$ export FLASK_APP=run.py
$ flask create-db
$ flask install 

and follow the instructions, this will create your first user and first admin role.

to run the system, you can use a management command:

$ flask run

to use Vue and Parcel bundler for development:

$ npm install
$ npm run watch

to build for production run:

$ npm run build 

Using Docker

$ git clone git@github.com:level09/enferno.git

$ cd enferno

$ docker-compose up

https://asciinema.org/a/219755

Running Celery

celery -A enfenro.tasks worker

you can add -b to activate Celery heartbeat (periodic tasks)

A sample task that runs within the app context has been prepared for you within the enfenro/tasks/__init__.py file, this is helpful if you have background tasks that interact with your SQLAlchemy models.

Features

  • Based on Flask.
  • Fully working user registration and authentication + user roles via Flask security
  • Memory caching via Redis and Flask caching
  • Command line scripting via Click
  • Relational database support with sql alchemy ORM
  • Background tasks via Celery
  • Email integration via Flask Mail
  • Files are structured based on best practices by utilizing Flask blueprints and development/production configuration

Showcase

Some of the websites running on Enferno:

Inspiration & Credits

License

MIT licensed.

You can’t perform that action at this time.