Skip to content

get-started.md

Latest commit

 

History

History
64 lines (43 loc) · 1.28 KB

get-started.md

File metadata and controls

64 lines (43 loc) · 1.28 KB

Getting Started

Installation

  • Node.js 4.x or 5.x
git clone https://github.com/CloudBreadProject/CloudBread-Socket.git
cd CloudBread-Socket
npm i # alias to install

Usage

Configurations

You should configure Redis options to authenticate users and connect multiple nodes. You can edit src/config.js file or provide environment variables to integrate Redis. REDIS_HOST, REDIS_PORT and REDIS_AUTH_KEY are required to create redis client.

Custom Scripts

Development

npm start
npm start -- --port=8080 # if you want to change the port

Never use this command for production directly because this command will be executed via babel-node which makes performance slower. To serve production application, you have to deploy or build it and execute npm start in the build folder. You can setup port from ./tools/config.js

Build

npm run build

It will build package for production.

Test

npm test

Lint

npm run lint

It will eslint this package.

Deployment

You should edit ./tools/tasks/deploy.js file before use this command.

npm run deploy

Basically this script deploys this package on git repository after build. GitHub, Heroku, Azure, AWS, AppEngine, whatever doesn't matter, perhaps.