FoundKey microblogging server.
Find a file
2016-12-31 12:20:13 +09:00
.ci-files Initial commit 🍀 2016-12-29 07:49:51 +09:00
.github Add issue template 2016-12-30 21:23:57 +09:00
docs Move src/web/about/pages --> docs/ 2016-12-31 06:50:13 +09:00
elasticsearch Initial commit 🍀 2016-12-29 07:49:51 +09:00
resources Add screen shot 2016-12-29 20:43:38 +09:00
src Clean up: Removes consecutive blank line 2016-12-31 11:02:58 +09:00
test Update test 2016-12-31 02:38:40 +09:00
.editorconfig Update .editorconfig 2016-12-31 02:21:10 +09:00
.gitattributes Initial commit 🍀 2016-12-29 07:49:51 +09:00
.gitignore Initial commit 🍀 2016-12-29 07:49:51 +09:00
.travis.yml Update .travis.yml 2016-12-29 10:44:50 +09:00
appveyor.yml Update appveyor.yml 2016-12-31 02:28:21 +09:00
CHANGELOG.md Add changelog 2016-12-30 13:12:25 +09:00
CONTRIBUTING.md Update CONTRIBUTING.md 2016-12-31 12:20:13 +09:00
Dockerfile ✌️ 2016-12-31 06:38:14 +09:00
gulpfile.js Initial commit 🍀 2016-12-29 07:49:51 +09:00
gulpfile.ts Move src/web/about/pages --> docs/ 2016-12-31 06:50:13 +09:00
init.js Update init.js 2016-12-29 10:05:11 +09:00
jsconfig.json Remove useless link 2016-12-31 03:42:55 +09:00
LICENSE Initial commit 🍀 2016-12-29 07:49:51 +09:00
package.json Update type definition 2016-12-31 02:37:03 +09:00
README.md Update README.md 2016-12-31 07:18:06 +09:00
tsconfig.json Update tsconfig.json 2016-12-29 10:56:24 +09:00
tslint.json Update tslint.json 2016-12-29 10:01:59 +09:00
update.sh Initial commit 🍀 2016-12-29 07:49:51 +09:00

Misskey

A miniblog-based SNS.

ss

Build

  1. Install git, Node.js and npm
  2. git clone git://github.com/syuilo/misskey.git
  3. cd misskey
  4. npm install
  5. npm run config
  6. npm run build

Test

npm test

Setup

Dependencies 📦

Please install these softwares.

Optional

  • Elasticsearch
    • If omit it, Misskey use the MongoDB for search instead. If not, Misskey will can better search.

Domains

Misskey requires two domains called the primary domain and the secondary domain.

  • The primary domain is used to provide main service of Misskey.
  • The secondary domain is used to avoid vulnerabilities such as XSS.

Ensure that the secondary domain is not a subdomain of the primary domain.

reCAPTCHA

Please visit https://www.google.com/recaptcha/intro/ and generate keys.

Setup with Docker 🐳

Ensure that the working directory is the repository root directory.

To create misskey image: sudo docker build -t misskey

To run misskey: sudo docker run --rm -i -t -p $PORT:80 -v $(pwd):/root/misskey -v $DBPATH:/data/db misskey

where $PORT is the port used to access Misskey Web from host browser and $DBPATH is the path of MongoDB database on the host for data persistence.

ex: sudo docker run --rm -i -t -p 80:80 -v $(pwd):/root/misskey -v /data/db:/data/db misskey

Note that $(pwd) is the working directory.

Launch

sudo npm start

Contribute

Do you have feature request or problem with Misskey? Please create issue to report it.

Currently Misskey is missing documents so writing documents would be appreciated. Pull requests are always welcome.

We love contributions from anybody.

Contribution guide

TODO

License

The MIT License