INTRODUCTION

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

FEATURES

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
- NOTE: If you are using pip 1.5 you need to add these parameters: --allow-external postmarkup --allow-unverified postmarkup
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
Database creation
- Development: Create the database with some example content
  - python manage.py createall
- Production: Create the database and the admin user
  - python manage.py initflaskbb
Run the development server
- python manage.py runserver
Visit localhost:8080

Upgrading from a previous installation
- Pull the latest changes from the repository
- git pull
See if the example config has changed and adjust the settings to your needs
- diff flaskbb/configs/production.py flaskbb/configs/production.py.example
- $EDITOR flaskbb/configs/production.py
Upgrade the database to the latest revision
- python manage.py db upgrade head