flaskbb/README.md

INTRODUCTION

FlaskBB is a forum software written in python using the micro framework Flask.

FEATURES

• A Bulletin Board like FluxBB, DjangoBB in Flask
• Private Messages
• Admin Interface
• Group based permissions
• BBCode support

TODO

• Topic Tracker (in progress)
• Track the unread posts and mark them as new
• A own theme and make FlaskBB themable with Flask-Themes2
• Localization (Babel)
• Searching for members, posts,...
• Subforums
• Figure out how to integrate it in another app where you can use the models from flaskbb and so on..

DEPENDENCIES

• Flask
  • Werkzeug
  • Jinja2
• Flask-SQLAlchemy
  • SQLAlchemy
• Flask-WTF
  • WTForms
• Flask-Login
• Flask-Mail
• Flask-Script

INSTALLATION

• Create a virtualenv
• Install the dependencies with pip install -r requirements.txt
• Copy flaskbb/configs/development.py.example to flaskbb/configs/development.py
• Create the database with some example content python manage.py createall
• Run the development server python manage.py runserver
• Visit localhost:8080

LICENSE

BSD LICENSE

ACKNOWLEDGEMENTS

/r/flask, Flask and it's extensions.