forked from ppfun/pixelplanet
update README
This commit is contained in:
parent
34f4b35c19
commit
aa346024fa
25
README.md
25
README.md
|
@ -22,18 +22,30 @@ Click or tab: Place Pixel
|
||||||
## Build
|
## Build
|
||||||
### Requirements
|
### Requirements
|
||||||
- [nodejs environment](https://nodejs.org/en/)
|
- [nodejs environment](https://nodejs.org/en/)
|
||||||
- (optional) [babel-cli](https://www.npmjs.com/package/babel-cli) (`sudo npm install --global babel-cli`)
|
|
||||||
|
|
||||||
### Building
|
### Building
|
||||||
Make sure that you have rights to g++ (if not, run as root and then `chown username:username -R .` after build)
|
Checkout repository
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://github.com/pixelplanetdev/pixelplanet.git
|
||||||
|
cd pixelplanet
|
||||||
|
```
|
||||||
|
|
||||||
|
Install packages and build
|
||||||
|
|
||||||
```
|
```
|
||||||
npm install
|
npm install
|
||||||
npm run build
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
All needed files to run it got created in `./build`
|
All needed files to run it got created in `./build`
|
||||||
|
|
||||||
#### Note:
|
#### Note:
|
||||||
If npm install fails with "unable to connect to github.com" set:
|
If you run into problems, make sure that you have rights to g++ (if not, run as root and then chown username:username -R . after build)
|
||||||
|
|
||||||
|
If `npm install` fails with "unable to connect to github.com" set:
|
||||||
|
|
||||||
```
|
```
|
||||||
git config --global url.https://github.com/.insteadOf git://github.com/
|
git config --global url.https://github.com/.insteadOf git://github.com/
|
||||||
```
|
```
|
||||||
|
@ -41,7 +53,6 @@ git config --global url.https://github.com/.insteadOf git://github.com/
|
||||||
## Run
|
## Run
|
||||||
### Requirements
|
### Requirements
|
||||||
- nodejs environment with [npm](https://www.npmjs.com/get-npm)
|
- nodejs environment with [npm](https://www.npmjs.com/get-npm)
|
||||||
- (optional)[babel-cli](https://www.npmjs.com/package/babel-cli) (`npm install -g babel-cli`)
|
|
||||||
- [pm2](https://github.com/Unitech/pm2) (`npm install -g pm2`) as process manager and for logging
|
- [pm2](https://github.com/Unitech/pm2) (`npm install -g pm2`) as process manager and for logging
|
||||||
- [redis](https://redis.io/) as database for storgìng the canvas
|
- [redis](https://redis.io/) as database for storgìng the canvas
|
||||||
- mysql or mariadb ([setup own user](https://www.digitalocean.com/community/tutorials/how-to-create-a-new-user-and-grant-permissions-in-mysql) and [create database](https://www.w3schools.com/SQl/sql_create_db.asp) for pixelplanet) for storing additional data like IP blacklist
|
- mysql or mariadb ([setup own user](https://www.digitalocean.com/community/tutorials/how-to-create-a-new-user-and-grant-permissions-in-mysql) and [create database](https://www.w3schools.com/SQl/sql_create_db.asp) for pixelplanet) for storing additional data like IP blacklist
|
||||||
|
@ -156,5 +167,9 @@ After=network.target mysql.service redis.service
|
||||||
|
|
||||||
### Development
|
### Development
|
||||||
|
|
||||||
Run `npm run lint:src` to check for code errors and warnings or `npm run lint -- ./your/file.js` to check a single file. We have enough warnings already, just don't produce too many additional ones.
|
Run `npm run lint:src` to check for code errors and warnings or `npm run lint -- ./your/file.js` to check a single file.
|
||||||
|
We have enough warnings already, just don't produce too many additional ones.
|
||||||
|
|
||||||
|
You can use `npm run babel-node ./your/script.js` to execute a script with local babel.
|
||||||
|
|
||||||
|
`npm run upgrade` can be use for interactively upgrading npm packages.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user