https://github.com/Fugoes/yapblog

Yet another personal blog, and more.
https://github.com/Fugoes/yapblog

Last synced: 2 months ago
JSON representation

Yet another personal blog, and more.

• Host: GitHub
• URL: https://github.com/Fugoes/yapblog
• Owner: Fugoes
• Created: 2017-11-04T00:33:48.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-01T11:58:40.000Z (almost 7 years ago)
• Last Synced: 2024-08-03T01:38:31.772Z (6 months ago)
• Language: Python
• Size: 1.64 MB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# yapblog

`yapblog` is acronym for `yet another personal blog`.

# Requirement

Please install `python3` with `flask`,`flask-login` and `flask-sqlalchemy` installed.

Please install `pandoc` for converting markdown to html.

# 项目结构

+ `yapblog/api/` : API

+ `yapblog/lib/` : 一些有用的函数

+ `yapblog/models/` : 与数据库的接口类，比如用户类 User

+ `yapblog/static/` : 静态文件

+ `yapblog/templates/` : 模板文件

+ `yapblog/views/` : 各个页面

+ `yapblog/config.py` : 配置文件

+ `tests/` : 测试

# `/api`

API 采用的模式是使用 JSON 来请求，并返回一个 JSON 格式的数据。使用的例子可以参考各个页面的模板文件。

## `/api/user`

与单个用户相关的接口，具体的参数与返回值参考 `yapblog.api.user` ：

+ `/api/user`

+ `/api/user/register`

+ `/api/user/login`

+ `/api/user/logout`

# `/register`

注册页面。

# `/login`

登录页面。

# `/logout`

登出页面。

# `/user`

用户信息页面。