maple-bbs/README.org

• Honmaple
  • Features
  • Installation
    • Install necessary package
    • Config
    • Init sql
    • create full text index
    • Create admin account
    • Login and visit admin
  • Demo
  • 功能
  • 安装
    • 安装需要的包
    • 配置
    • 初始化数据库
    • 创建全文搜索索引
    • 创建管理员账户
    • 登陆并访问后台
  • 演示
  • License

Honmaple

English | 中文

This is a free,open-source forums system based on the flask

#<<english>>

If you have used honmaple before 2017-4-1,please use upgrade script to upgrade data

important ! : please modify script to configure as your own database.

# session1:old database
# session2:new database
python upgrade.py
python upgrade_count.py

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

 mkvirtualenv forums

Install necessary package

pip install -r requirements.txt

Beacause newest flask_maple isn't uploaded to pypi you should

  git clone https://github.com/honmaple/flask-maple
  cd flask-maple
  pip uninstall flask-maple
  python setup.py install

to install flask-maple

Config

mv config.example config.py

remember to modify config file.

Init sql

python manager.py db init 
python manager.py db migrate -m "first migrate"
python manager.py db upgrade

Or

python manager.py init_db

create full text index

python manager.py create_index

Create admin account

python manager.py create_user

Login and visit admin

Ok ,visit forums.localhost:5000/admin to add something

Demo

Please visit forums.honmaple.org

#<<chinese>> 如果你在4月1日之前部署过，请使用升级脚本升级你的数据

重要!,请修改升级脚本为你自己的数据库

 # session1:old database
 # session2:new database
 python upgrade.py
 python upgrade_count.py

功能

• 注册，登陆,忘记密码
• 版块及节点分类
• 主题收藏
• 回复点赞
• 关注用户，节点，主题
• 隐私设置
• 可选markdown提问
• 节点rss
• 头像…
• 全文搜索(基于whoosh)

安装

创建虚拟环境

 mkvirtualenv forums

安装需要的包

pip install -r requirements.txt

因为最新的*flask-maple*还未上传到pypi,所以

  git clone https://github.com/honmaple/flask-maple
  cd flask-maple
  pip uninstall flask-maple
  python setup.py install

来安装flask-maple

配置

mv config.example config.py

记得修改配置文件

初始化数据库

python manager.py db init 
python manager.py db migrate -m "first migrate"
python manager.py db upgrade

或者

python manager.py init_db

创建全文搜索索引

python manager.py create_index

创建管理员账户

python manager.py create_user

登陆并访问后台

python runserver.py

然后访问*forums.localhost:5000/admin*去增加一些东西

演示

请访问 forums.honmaple.org

License

Honmaple is open-sourced software licensed under the GPL3 license