* maple-bbs

  [[LICENSE][https://img.shields.io/badge/license-GPL3.0-blue.svg]]
  [[https://www.python.org][https://img.shields.io/badge/python-3.4-brightgreen.svg]]

  [[README.org][English]] | [[README_zh.org][中文]]

  [[https://raw.githubusercontent.com/honmaple/maple-bbs/master/screenshooter/index.png]]
  [[https://raw.githubusercontent.com/honmaple/maple-bbs/master/screenshooter/board.png]]
  [[https://raw.githubusercontent.com/honmaple/maple-bbs/master/screenshooter/ask.png]]
  

  This is a free,open-source forums system based on the flask
  
  *If you have used maple-bbs before 2017-4-1,please use upgrade script to upgrade data*
  
  *important !* : please modify script to configure as your own database.
  #+BEGIN_SRC sh
  # session1:old database
  # session2:new database
  python upgrade.py
  python upgrade_count.py
  #+END_SRC

** Features
   + Register & login & forget password
   + Board and tags
   + Collect
   + Like replies
   + Follow tags,users,topics
   + Privacy setting
   + Choice markdown to ask
   + Tags rss
   + Avatar
   + Full text search with whoosh
     
** Installation
   
   #+BEGIN_SRC sh
    mkvirtualenv forums
   #+END_SRC

*** Install necessary package
    #+BEGIN_SRC python
    pip install -r requirements.txt
    #+END_SRC

*** Config
    #+BEGIN_SRC shell
    mv config.example config.py
    #+END_SRC
    remember to modify config file.

*** Init sql
    #+BEGIN_SRC python
    python manager.py db init 
    python manager.py db migrate -m "first migrate"
    python manager.py db upgrade
    #+END_SRC
    Or
    #+BEGIN_SRC sh
    python manager.py init_db
    #+END_SRC

*** create full text index
    #+BEGIN_SRC sh
    python manager.py create_index
    #+END_SRC
*** Create admin account
    #+BEGIN_SRC shell
    python manager.py create_user
    #+END_SRC

*** Login and visit admin 
    *Ok* ,visit forums.localhost:8000/admin to add something

** Demo
   Please visit [[https://forums.honmaple.org][forums.honmaple.org]] 

** License
   maple-bbs is open-sourced software licensed under the GPL3 license