No Description

sh4nks c2933ce1e2 Moved save, delete, move and merge to the bottom		11 years ago
docs	76e8da3917 Added sidebarintro.	11 years ago
flaskbb	c2933ce1e2 Moved save, delete, move and merge to the bottom	11 years ago
logs	ce6e90fc96 Initial commit	11 years ago
migrations	2836c05fa3 I have somehow fucked that up..	11 years ago
tests	1797339faa Renamed topic_normal to topic and normal_user to user.	11 years ago
.gitignore	3b17a8ac7f squash commits	11 years ago
.gitmodules	c9b6c62a78 My first attempt to create docs with sphinx.	11 years ago
.travis.yml	9bc805b84e Refactored the update_read method in the Topic class.	11 years ago
AUTHORS	ce6e90fc96 Initial commit	11 years ago
CHANGES	ce6e90fc96 Initial commit	11 years ago
LICENSE	b8a25f1a4c It's 2014	11 years ago
Makefile	3060e6a8b5 Added Makefile	11 years ago
README.md	a3360843ed Updated TODO List	11 years ago
manage.py	41b3ca9050 Added framework for tests	11 years ago
pytest.ini	7831bb438c Some cleanup	11 years ago
requirements.txt	5d12696343 Updated requirements	11 years ago
setup.py	edfb182c7b Updated requirements	11 years ago
wsgi.py	ce6e90fc96 Initial commit	11 years ago

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