misskey/README.md

107 lines
3.3 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]
2016-12-31 04:37:21 +00:00
Welcome!
2016-12-31 04:48:10 +00:00
Misskey is a completely open source, ultimately sophisticated new type of mini-blog based SNS.
2016-12-28 22:49:51 +00:00
2016-12-29 11:43:33 +00:00
![ss](./resources/ss.jpg)
2016-12-31 05:15:37 +00:00
## Features
* Automatically updated timeline
2016-12-31 05:11:31 +00:00
* Private chatting (messaging)
2016-12-31 05:15:49 +00:00
* Free 1GB storage
2016-12-31 05:11:31 +00:00
* Mobile device support (smartphone, tablet, etc)
2016-12-31 05:16:13 +00:00
* Thirdparty application support
2016-12-31 05:11:31 +00:00
2017-01-02 20:28:54 +00:00
and more! You can touch with your own eyes at https://misskey.xyz/.
2016-12-31 05:11:31 +00:00
2016-12-31 05:12:15 +00:00
## Building
2016-12-30 22:18:06 +00:00
1. Install *git*, *Node.js* and *npm*
2016-12-30 17:44:45 +00:00
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
2017-01-16 22:51:27 +00:00
ビルドしてから:
2016-12-30 17:44:45 +00:00
`npm test`
## Setup
2016-12-30 22:06:38 +00:00
### Dependencies :package:
2016-12-30 17:47:45 +00:00
Please install these softwares.
2016-12-30 20:25:26 +00:00
* **[MongoDB](https://www.mongodb.com/)**
* **[Redis](https://redis.io/)**
* **[GraphicsMagick](http://www.graphicsmagick.org/)**
2016-12-30 22:06:38 +00:00
#### Optional
2016-12-31 04:05:15 +00:00
* [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB
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-30 21:58:52 +00:00
## Setup with Docker :whale:
2016-12-30 21:38:14 +00:00
Ensure that the working directory is the repository root directory.
To create misskey image:
2016-12-31 08:33:53 +00:00
2016-12-31 04:00:11 +00:00
`sudo docker build -t misskey ./docker`
2016-12-30 21:38:14 +00:00
To run misskey:
2016-12-31 08:33:53 +00:00
2016-12-30 21:38:14 +00:00
`sudo docker run --rm -i -t -p $PORT:80 -v $(pwd):/root/misskey -v $DBPATH:/data/db misskey`
2016-12-31 08:36:11 +00:00
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.
2016-12-30 21:38:14 +00:00
ex: `sudo docker run --rm -i -t -p 80:80 -v $(pwd):/root/misskey -v /data/db:/data/db misskey`
2016-12-31 08:33:53 +00:00
If you want to run misskey in production mode, add `--env NODE_ENV=production` like this:
2016-12-31 08:35:07 +00:00
`sudo docker run --rm -i -t -p 80:80 -v $(pwd):/root/misskey -v /data/db:/data/db --env NODE_ENV=production misskey`
2016-12-31 08:33:53 +00:00
2016-12-31 08:36:11 +00:00
Note that `$(pwd)` is the working directory.
2016-12-30 21:38:14 +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?
2016-12-31 09:16:27 +00:00
Please create issue to report it if it is about the Misskey implementation itself.
2016-12-30 18:50:21 +00:00
Currently Misskey is missing documents so writing documents would be appreciated.
Pull requests are always welcome.
2016-12-30 19:02:01 +00:00
We love contributions from anybody.
2016-12-30 22:09:29 +00:00
[Contribution guide](./CONTRIBUTING.md)
2016-12-30 20:35:23 +00:00
### TODO
2016-12-30 22:15:48 +00:00
* More [tests](./test)!
* More [docs](./docs)!
2016-12-31 04:53:29 +00:00
* More cleaning up code!
2016-12-30 20:35:23 +00:00
2017-01-01 17:17:53 +00:00
## Copyright
2017-01-01 17:18:23 +00:00
Misskey is open-source software licensed under [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