Update README.md
This commit is contained in:
parent
deb5dc04aa
commit
f500afeb42
30
README.md
30
README.md
@ -9,16 +9,20 @@ A miniblog-based SNS.
|
|||||||
|
|
||||||
![ss](./resources/ss.jpg)
|
![ss](./resources/ss.jpg)
|
||||||
|
|
||||||
## Dependencies
|
## Build
|
||||||
* Node.js
|
1. Install git, Node.js and npm
|
||||||
* MongoDB
|
2. `git clone git://github.com/syuilo/misskey.git`
|
||||||
* Redis
|
3. `cd misskey`
|
||||||
* GraphicsMagick
|
4. `npm install`
|
||||||
|
5. `npm run config`
|
||||||
|
6. `npm run build`
|
||||||
|
|
||||||
### Optional
|
## Test
|
||||||
* Elasticsearch
|
`npm test`
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
Install MongoDB, Redis, GraphicsMagick and optionally Elasticsearch
|
||||||
|
|
||||||
## Get started
|
|
||||||
### Domains
|
### Domains
|
||||||
Misskey requires two domains called the primary domain and the secondary domain.
|
Misskey requires two domains called the primary domain and the secondary domain.
|
||||||
|
|
||||||
@ -30,16 +34,6 @@ Misskey requires two domains called the primary domain and the secondary domain.
|
|||||||
### reCAPTCHA
|
### reCAPTCHA
|
||||||
Please visit https://www.google.com/recaptcha/intro/ and generate keys.
|
Please visit https://www.google.com/recaptcha/intro/ and generate keys.
|
||||||
|
|
||||||
## Build
|
|
||||||
1. `git clone git://github.com/syuilo/misskey.git`
|
|
||||||
2. `cd misskey`
|
|
||||||
3. `npm install`
|
|
||||||
4. `npm run config`
|
|
||||||
5. `npm run build`
|
|
||||||
|
|
||||||
## Test
|
|
||||||
`npm test`
|
|
||||||
|
|
||||||
## Launch
|
## Launch
|
||||||
`sudo npm start`
|
`sudo npm start`
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user