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
• Topic Tracker
• Unread Topics/Forums

TODO

• Searching for members, posts,...
• "Link to"-Forum type
• Move a topic in a other forum
• Merging 2 topics together
• Reporting posts
• Userstyles (e.q.: colored username)
• Database migrations
• A own theme and make FlaskBB themable with Flask-Themes2
• Localization (Babel)
• Polls

DEPENDENCIES

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

OPTIONAL DEPENDENCIES

• Pygmens - For code highlighting
• Redis - For counting the online guests

INSTALLATION

• Create a virtualenv

  • Install virtualenvwrapper with your package manager or via

    • sudo pip install virtualenvwrapper

  • Add these lines to your .bashrc

    export WORKON_HOME=$HOME/.virtualenvs  # Location for your virtualenvs
    source /usr/local/bin/virtualenvwrapper.sh
    

  • Create a new virtualenv

    • mkvirtualenv -a /path/to/flaskbb -p $(which python2) flaskbb

  • and finally activate it

    • workon flaskbb

  • For more options visit the documentation here.

• Install the dependencies

  • pip install -r requirements.txt

• Configuration (adjust them accordingly to your needs)

  • For development copy flaskbb/configs/development.py.example to flaskbb/configs/development.py
  • For production copy flaskbb/configs/production.py.example to flaskbb/configs/production.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.