Fbone (Flask bone) is a Flask (Python microframework) template/bootstrap/boilerplate application.
Python HTML CSS Other
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 4 commits ahead of frankV:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
fbone
migrations
tests
.gitignore
LICENSE
README.md
app.wsgi
babel.cfg
fabfile.py
fabric_gunicorn.py
manage.py
requirements.txt

README.md

Manekineko

Manekineko is a fork of Fbone, a Flask (Python microframework) boilerplate application with best practices, using a domain driven approach.

Build Status

You can use it for:

  • learning Flask
  • kicking off your new project faster
  • having a highly scalable and modular app structure

FEATURES

Frontend Framework

Flask Extensions

Others

  • Well designed structure for large projects
  • Quick deploys via fabric
  • Admin interface
  • Homebaked logger

USAGE

Pre-required:

  • git
  • pip
  • sqlite

Suggested:

  • virtualenv
  • virtualenv wrapper
  • MySQL/PostgreSQL

To get started, verify database settings in fbone/config.py then run:

$ python manage.py initdb

Then start the server with:

$ python manage.py runserver

Then open http://127.0.0.1:5000

IMPORTANT:

  • Change INSTANCE_FOLDER_PATH in fbone/utils.py to suit yourself.
  • Put *.cfg under INSTANCE_FOLDER_PATH.
## STRUCTURE

    ├── fbone
    │   ├── factory.py              (application factory)
    │   ├── config.py               (config module)
    │   ├── modules                 (MVC modules)
    │   │   ├── admin               (admin module)
    │   │   ├── api                 (api module)
    │   │   ├── frontend            (frontend module)
    │   │   ├── settings            (settings module)
    │   │   └── user                (user module)
    │   │       ├── __init__.py
    │   │       ├── commands.py
    │   │       ├── constants.py
    │   │       ├── forms.py
    │   │       ├── models.py
    │   │       └── views.py
    │   ├── core                    (core app utilities)
    │   │   ├── assets.py           (flask-assets web-assets manager)
    │   │   ├── decorators.py       (route decorators)
    │   │   ├── email.py            (email methods)
    │   │   ├── extensions.py       (flask extensions)
    │   │   ├── flash.py            (flask.flash() wrapper)
    │   │   ├── helpers.py          (convenience functions and classes)
    │   │   ├── oauth.py            (oauth settings and provider logic)
    │   │   ├── types.py            (custom column types and extensions)
    │   │   └── utils.py            (utility methods, like `get_current_date()`)
    │   ├── static
    │   │   ├── css
    │   │   ├── img
    │   │   └── js
    │   ├── templates
    │   ├── translations            (i18n)
    │   ├── utils.py
    ├── LICENSE
    ├── manage.py                   (manage via flask-script)
    ├── README.md
    └── tests                       (unit tests, run with pytest)

LICENSE

MIT LICENSE

ACKNOWLEDGEMENTS

Thanks to Flask extension authors, various blogs, and the hard work of:

Original work done by: