Skip to content

Fbone (Flask bone) is a Flask (Python microframework) template/bootstrap/boilerplate application.

License

Notifications You must be signed in to change notification settings

frankV/manekineko

 
 

Repository files navigation

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)
    │   ├── decorators.py           (route decorators)
    │   ├── extensions.py           (flask extensions)
    │   ├── 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)
    │   │   ├── email.py            (email methods)
    │   │   ├── flash.py            (flask.flash() wrapper)
    │   │   ├── helpers.py          (convenience functions and classes)
    │   │   └── oauth.py            (oauth settings and provider logic)
    │   ├── 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:

About

Fbone (Flask bone) is a Flask (Python microframework) template/bootstrap/boilerplate application.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 65.7%
  • HTML 19.5%
  • CSS 13.6%
  • Other 1.2%