Sharkey/README.md

100 lines
3 KiB
Markdown
Raw Normal View History

2016-12-29 00:49:51 +02:00
# Misskey
[![][travis-badge]][travis-link]
2016-12-30 14:38:00 +02:00
[![][appveyor-badge]][appveyor-link]
2016-12-29 00:49:51 +02:00
[![][dependencies-badge]][dependencies-link]
[![][mit-badge]][mit]
2016-12-31 06:37:21 +02:00
Welcome!
2016-12-31 06:48:10 +02:00
Misskey is a completely open source, ultimately sophisticated new type of mini-blog based SNS.
2016-12-29 00:49:51 +02:00
2016-12-29 13:43:33 +02:00
![ss](./resources/ss.jpg)
2016-12-31 07:15:37 +02:00
## Features
* Automatically updated timeline
2016-12-31 07:11:31 +02:00
* Private chatting (messaging)
2016-12-31 07:15:49 +02:00
* Free 1GB storage
2016-12-31 07:11:31 +02:00
* Mobile device support (smartphone, tablet, etc)
2016-12-31 07:16:13 +02:00
* Thirdparty application support
2016-12-31 07:11:31 +02:00
and more!
2016-12-31 07:12:15 +02:00
## Building
2016-12-31 00:18:06 +02:00
1. Install *git*, *Node.js* and *npm*
2016-12-30 19:44:45 +02: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-29 00:49:51 +02:00
2016-12-30 19:44:45 +02:00
## Test
`npm test`
## Setup
2016-12-31 00:06:38 +02:00
### Dependencies :package:
2016-12-30 19:47:45 +02:00
Please install these softwares.
2016-12-30 22:25:26 +02:00
* **[MongoDB](https://www.mongodb.com/)**
* **[Redis](https://redis.io/)**
* **[GraphicsMagick](http://www.graphicsmagick.org/)**
2016-12-31 00:06:38 +02:00
#### Optional
2016-12-31 06:05:15 +02:00
* [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB
2016-12-29 00:49:51 +02:00
2016-12-29 17:23:25 +02:00
### Domains
2016-12-29 00:49:51 +02: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 17:23:25 +02:00
### reCAPTCHA
2016-12-30 19:39:46 +02:00
Please visit https://www.google.com/recaptcha/intro/ and generate keys.
2016-12-29 17:23:25 +02:00
2016-12-30 23:58:52 +02:00
## Setup with Docker :whale:
2016-12-30 23:38:14 +02:00
Ensure that the working directory is the repository root directory.
To create misskey image:
2016-12-31 06:00:11 +02:00
`sudo docker build -t misskey ./docker`
2016-12-30 23:38:14 +02:00
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.
2016-12-29 00:49:51 +02:00
## Launch
2016-12-29 17:16:47 +02:00
`sudo npm start`
2016-12-29 00:49:51 +02:00
2016-12-30 20:50:21 +02: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-30 21:02:01 +02:00
We love contributions from anybody.
2016-12-31 00:09:29 +02:00
[Contribution guide](./CONTRIBUTING.md)
2016-12-30 22:35:23 +02:00
### TODO
2016-12-31 00:15:48 +02:00
* More [tests](./test)!
* More [docs](./docs)!
2016-12-31 06:53:29 +02:00
* More cleaning up code!
2016-12-30 22:35:23 +02:00
2016-12-29 00:49:51 +02:00
## License
2016-12-30 20:51:12 +02:00
[The MIT License](LICENSE)
2016-12-29 00:49:51 +02: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 14:40:19 +02:00
[travis-badge]: http://img.shields.io/travis/syuilo/misskey.svg?style=flat-square&label=Linux
2016-12-30 14:38:00 +02:00
[appveyor-link]: https://ci.appveyor.com/project/syuilo/misskey
2016-12-30 14:40:19 +02:00
[appveyor-badge]: https://img.shields.io/appveyor/ci/syuilo/misskey/master.svg?style=flat-square&label=Windows
2016-12-29 00:49:51 +02:00
[dependencies-link]: https://gemnasium.com/syuilo/misskey
[dependencies-badge]: https://img.shields.io/gemnasium/syuilo/misskey.svg?style=flat-square