/egg-cnode

CNode 社区 Egg 版本

Primary LanguageJavaScriptMIT LicenseMIT

cnode

build status Test coverage David deps Known Vulnerabilities

QuickStart

see egg docs for more detail.

Environment Dependencies

macOS Install

brew install redis mongodb
brew services start redis
brew services start mongodb

Linux Install

TBD

Windows Install

TBD

Development

$ npm i
$ npm run dev
$ open http://localhost:7001/

Develop with docker

Setup redis / mongodb, requirements:

  • docker
  • docker-compose
# start
docker-compose -f docker-compose.dev.yml up

# stop 
docker-compose -f docker-compose.dev.yml down

# remove volume/cache
docker-compose -f docker-compose.dev.yml down -v

Deploy

$ npm start
$ npm stop

Deploy with docker

Setup redis / mongodb / egg-cnode, requirements:

  • docker
  • docker-compose

Modify Github Id/Secret

version: '3'
services: 
  cnode:
    environment:
      - EGG_PASSPORT_GITHUB_CLIENT_ID=test
      - EGG_PASSPORT_GITHUB_CLIENT_SECRET=test

Modify Alinode AppId/Secret

version: '3'
services: 
  cnode:
    environment:
      - EGG_ALINODE_APPID=appid
      - EGG_ALINODE_SECRET=secret

to disable alinode, modify config/plugin.prod.js

Change Port

version: '3'
services: 
  cnode:
    ports:
      - ${PORT}:7001

Run / Stop

# start
docker-compose up -d

# stop 
docker-compose down

# remove volume/cache
docker-compose down -v

npm scripts

  • Use npm run lint to check code style.
  • Use npm test to run unit test.
  • Use npm run autod to auto detect dependencies upgrade, see autod for more detail.