profxadke/misskey
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Oppa. $check #m8!
113 commits 92 branches 488 tags 164 MiB
TypeScript 52.5%
Vue 38.2%
JavaScript 8.6%
Pug 0.3%
SCSS 0.2%
Find a file
syuilo⭐️ 06fae75961 Update README.md
2016-12-31 05:35:23 +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
docker Support Docker 2016-12-31 02:19:49 +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 Update broadcast message 2016-12-31 03:57:16 +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 Add contributing doc 2016-12-30 21:23:57 +09:00
gulpfile.js Initial commit 🍀 2016-12-29 07:49:51 +09:00
gulpfile.ts Update log message 2016-12-29 21:02: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 05:35:23 +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

README.md

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.

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.

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.

TODO

  • More tests!
  • More docs!
  • More refactorings!

License

The MIT License