Table of Contents generated with DocToc

• Project Name
  • Roadmap
  • Contributing
  • Usage
  • Requirements
  • Setup (Mac)
    • Node Setup
    • MySQL Setup
      • install mysql
      • start mysql
      • create database
    • Python Setup
      • install python
    • Airbnb Style Guide Setup
      • global
      • local
      • configure .eslintrc (global/local)
  • Development
    • npm Scripts
      • install
      • start
      • dev-start (with nodemon)
      • lint test (with eslint)
      • unit test (with mocha)
      • test
      • coverage (istanbul with mocha)
  • Other Information

Project Name

lena consumer web service

Roadmap

Contributing

Usage

Requirements

• Node 8.3.0
• MySQL 5.7.20
• MySQL Workbench 6.3

Setup (Mac)

Node Setup

$ brew install node
$ node --version

MySQL Setup

install mysql

$ brew install mysql
$ mysql --version

start mysql

$ brew services start mysql

create database

$ mysql -u <user> -p <password>
mysql> CREATE DATABASE consumer;
mysql> CREATE DATABASE test_consumer;

Python Setup

install python

read the instructions given by the 'brew install python' command we are going to use python2 and pip2 only refer https://docs.brew.sh/Homebrew-and-Python.html

$ brew install python
$
$ python2 --version
$ pip2 --version

Airbnb Style Guide Setup

global

$ npm install -g eslint-config-airbnb eslint eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react

local

$ npm install --save-dev eslint-config-airbnb eslint eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react

configure .eslintrc (global/local)

$ cat .eslintrc.js
// These rules enforce the Airbnb style guide.

module.exports = {
  extends: 'airbnb',
  env: { browser: true },
};

Development

npm Scripts

install

$ npm install

start

$ npm start

dev-start (with nodemon)

$ npm dev-start

lint test (with eslint)

$ npm lint

unit test (with mocha)

$ npm unit

test

$ npm test

coverage (istanbul with mocha)

$ npm coverage

Other Information