misskey/README.md

58 lines
1.5 KiB
Markdown
Raw Normal View History

2016-12-28 22:49:51 +00:00
# Misskey
[![][travis-badge]][travis-link]
2016-12-30 12:38:00 +00:00
[![][appveyor-badge]][appveyor-link]
2016-12-28 22:49:51 +00:00
[![][dependencies-badge]][dependencies-link]
[![][mit-badge]][mit]
A miniblog-based SNS.
2016-12-29 11:43:33 +00:00
![ss](./resources/ss.jpg)
2016-12-28 22:49:51 +00:00
## Dependencies
* Node.js
* MongoDB
* Redis
* GraphicsMagick
2016-12-30 12:48:18 +00:00
### Optional
2016-12-28 22:49:51 +00:00
* Elasticsearch
## Get started
2016-12-29 15:23:25 +00:00
### Domains
2016-12-28 22:49:51 +00:00
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.**
2016-12-29 15:23:25 +00:00
### reCAPTCHA
Visit and generate keys
https://www.google.com/recaptcha/intro/
2016-12-28 22:49:51 +00:00
## Build
1. `git clone git://github.com/syuilo/misskey.git`
2. `cd misskey`
3. `npm install`
4. `npm run config`
5. `npm run build`
2016-12-30 04:55:58 +00:00
## Test
`npm test`
2016-12-28 22:49:51 +00:00
## Launch
2016-12-29 15:16:47 +00:00
`sudo npm start`
2016-12-28 22:49:51 +00:00
## License
[MIT](LICENSE)
[mit]: http://opensource.org/licenses/MIT
[mit-badge]: https://img.shields.io/badge/license-MIT-444444.svg?style=flat-square
[travis-link]: https://travis-ci.org/syuilo/misskey
2016-12-30 12:40:19 +00:00
[travis-badge]: http://img.shields.io/travis/syuilo/misskey.svg?style=flat-square&label=Linux
2016-12-30 12:38:00 +00:00
[appveyor-link]: https://ci.appveyor.com/project/syuilo/misskey
2016-12-30 12:40:19 +00:00
[appveyor-badge]: https://img.shields.io/appveyor/ci/syuilo/misskey/master.svg?style=flat-square&label=Windows
2016-12-28 22:49:51 +00:00
[dependencies-link]: https://gemnasium.com/syuilo/misskey
[dependencies-badge]: https://img.shields.io/gemnasium/syuilo/misskey.svg?style=flat-square