Skip to content

README.md

Latest commit

 

History

History
76 lines (61 loc) · 2.67 KB

README.md

File metadata and controls

76 lines (61 loc) · 2.67 KB

Termina

实体定义

项目

{
  "id": ID,
  "name": 项目名称（必须、唯一）,
  "description": 项目描述（非必须）,
  "inserted_at": 创建时间,
  "updated_at": 修改时间
}

词条

{
  "id": ID,
  "project_id": 关联项目ID（必须），
  "english": 英文（必须、在项目内同一个词性唯一）,
  "chinese": 中文（必须）,
  "part_of_speech": 词性（必须，名词|动词|形容词|其他）,
  "description": 解释（非必须）,
  "inserted_at": 创建时间,
  "updated_at": 修改时间
}

异常

{
  异常字段名: [异常信息]
}

Phoenix WebSocket 接口：

名称 通道 连接/上行/下行 事件 Payload 响应 成功后广播事件
- project:all 连接 - - 项目列表 -
- project:<项目ID> 连接 - - 词条列表 -
创建项目 project:all 上行 +project 项目（不含id和时间戳） 项目/异常 +project
创建项目 project:all 下行 +project - 项目 -
删除项目 project:all 上行 -project 项目 项目/异常 -project
删除项目 project:all 下行 -project - 项目 -
修改项目 project:all 上行 ^project 项目 项目/异常 ^project
修改项目 project:all 下行 ^project - 项目 -
复制项目 project:all 上行 ~project {"original_id": 原项目ID, "new_name": 新项目名称} 项目/异常 +project
创建词条 project:<项目ID> 上行 +term 词条（不含id和时间戳） 词条/异常 +term
创建词条 project:<项目ID> 下行 +term - 词条 -
删除词条 project:<项目ID> 上行 -term 词条 词条/异常 -term
删除词条 project:<项目ID> 下行 -term - 词条 -
修改词条 project:<项目ID> 上行 ^term 词条 词条/异常 ^term
修改词条 project:<项目ID> 下行 ^term - 词条 -

To start your Phoenix server:

  • Install dependencies with mix deps.get
  • Create and migrate your database with mix ecto.setup
  • Start Phoenix endpoint with mix phx.server

Now you can visit localhost:4000 from your browser.

Ready to run in production? Please check our deployment guides.

Learn more