Skip to content
This repository has been archived by the owner on Mar 27, 2020. It is now read-only.

Latest commit

 

History

History
46 lines (37 loc) · 1.42 KB

README.md

File metadata and controls

46 lines (37 loc) · 1.42 KB

Misskey API

Misskey API is written in TypeScript.

External dependencies

  • Node.js
  • npm
  • MongoDB
  • Redis
  • GraphicsMagick
  • OpenSSL

Branches

  • master - Main branch.
  • release - JavaScript code that is generated by TypeScript. This branch is updated automatically by Travis CI.

How to build

Ensure that you have node-gyp installed.

  1. git clone git://github.com/MissKernel/Misskey-API.git
  2. cd Misskey-API
  3. npm install
  4. npm run dts
  5. npm run build

How to run tests

npm run test

How to start Misskey API server

npm start

License

The MIT License. See LICENSE.