misskey/README.md

63 lines
1.8 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-30 17:44:45 +00:00
## 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`
2016-12-28 22:49:51 +00:00
2016-12-30 17:44:45 +00:00
## Test
`npm test`
## Setup
2016-12-30 17:47:45 +00:00
### Dependencies
Please install these softwares.
* MongoDB
* Redis
* GraphicsMagick
* Elasticsearch (optional)
2016-12-28 22:49:51 +00:00
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
2016-12-30 17:39:46 +00:00
Please visit https://www.google.com/recaptcha/intro/ and generate keys.
2016-12-29 15:23:25 +00:00
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
2016-12-30 18:50:21 +00:00
## 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.
2016-12-28 22:49:51 +00:00
## License
2016-12-30 18:51:12 +00:00
[The MIT License](LICENSE)
2016-12-28 22:49:51 +00:00
[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