wx-api-rewards-member-accounts

An API to manage Woolworth contacts. Email, Home phone and mobile Please see the swagger located at src/lib/api/swagger.yaml for more details

Getting started

Install dependencies:

npm install 

Prepare database:

npm run prepare-test-db

Run tests:

npm run test 

Start server in dev mode:

npm start

Run tests with watch:

npm run test-watch

Run test coverage:

npm run coverage

Run lint

npm run lint 

Work with submodules

Setup and install package:

mkdir @wooliesxloyalty
cd @wooliesxloyalty
git clone <pkg-to-work-on>
cd ../

Edit your submodule's package.json to new version

Edit your root level package.json to the new version of your submodule

Finally, use lerna to handle your submodule's symlinking

npm run bootstrap 

Changes

Please ensure all changes to this api adhere to WooliesX Developer best practice. WooliesXApis have automated deployment, which will be triggered as follows:

| Branch | Environment | Deployment Checks | | :------------- |:---- | :----- | | feature/JIRA-101-description | dev | Unit-test, linting | | bugfix/JIRA-101-description | dev | Unit-test, linting | | develop | test | Unit-test, linting, Code-Review | | release | uat | Code-Review, Security Tests, Functional Tests | | master | production | Approval Gate |

Unit testing and linting will be automatically run for feature branches, and the status of these checks will be published to the branch, to be displayed against PR's for test. Please ensure the following passes before trying to move to the test environment:

npm run lint 

npm run ci-test