Skip to content

ulysseswolf/flaskbb

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

INTRODUCTION

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

FEATURES

  • A Bulletin Board like FluxBB, DjangoBB in Flask
    • with Subforums
  • Private Messages
  • Admin Interface
  • Group based permissions
  • BBCode support
  • Topic Tracker
  • Unread Topics/Forums

TODO

  • High Priority:
    • Searching for members, posts,...
    • Move the topic in another forum
    • Fixing all bugs I encounter during development
  • Medium Priority:
    • Database migrations
    • A own theme and make FlaskBB themable with Flask-Themes2
    • Localization (Babel)
    • Polls - I definitely want this! :)
  • Low Priority:
    • Learn how to create a Plugin API so other developers can create plugins for FlaskBB
    • Figure out how to integrate it in another app

DEPENDENCIES

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
  • Create the development config

    • cp flaskbb/configs/development.py.example 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.

About

A forum software written in flask

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published