customer-management-service v1.0.0

CMS Serverless

CMS Serverless is service for managment of customer and end-users of Babyscripts Platform.

Getting Started

CMS Serverless can easily be setup in Mac OS, Windows and Ubuntu

Prerequisites

To get up and running you need to install following dependencies on your system.

Node.js 8.10.x
Npm 5 or above
Typescript 2.4 or above
Serverless Framework 1.x
AWS Lambda, DynamoDB, SQS, SNS, IAM and API Gateway

Installing

After installation of above prerequisites

Run npm install in project dir

Copy config files in config dir from cms-serverless s3 bucket

Each env config has it own set of files in config dir local, dev, staging, prod.

Running the tests

There are two types of test in CMS repo unit and integration resides in tests directory. In unit test we mock Aws and third party apis, code is run in isolated env. In integration test we use actual database and other services but using pre-baked environment.

Testing tools

Mocha 5.x or above (test runner)
Chai.js 4.x (assertion library)
Sinon.js 4.5.x (mocks and stubs)

Deployment

The entire Service Stack can easily be deployed using a single command.

sls deploy --aws-profile $PROFILE

Contributing

Please read CONTRIBUTING.md.

Authors

• Chun Wong - Architect - cptjellybeans
• Nauman - Engineer - organic-scholar

See also the list of contributors who participated in this project.

License

This project is licensed under the Proprietary License - see the LICENSE.md file for details

Acknowledgments

• None