InceptionPad Microservice Client

Install

yarn global add @inceptionpad/incpad-ms-cli

Usage

incpadMS -h

1. Credentials

​Please configure AWS credentials at the first time using the client.

incpadMS credentials -h

​Output:

Usage: credentials [options]

Options:
  -k, --key <key>                    set aws_access_key_id
  -s, --secret <secret>              set aws_secret_access_key
  -n, --profile-name <profile_name>  set AWS credentials profile name
  -h, --help                         output usage information

2. Integrate services into a project

As a microservice user, you can fork a microservice template with below command on the root directory of the project.

incpadMS integrate

3. Develop a new service

As a developer planning to develop a new microservice, you should fetch an empty service project with below command.

incpadMS init -h

​Output:

Usage: init [options] <project_name>

Options:
  -s, --sentry-token <sentry_token>   specify the sentry project token
  -w, --without-dep                   do not install dependence
  -b, --branch <branch>               branch of git repo
  -h, --help,                         output usage information

• --sentry-token option is for setting the sentry token of this project.
• --without-dep option is for initializing microservice project without installing dependences.
• --branch option is for specifing the branch of target repo.

4. Deploy

You can easily deploy the microservice to AWS serverless.

incpadMS deploy -h

Output:

Usage: deploy [options] [profile_name]

Options:
  --help, -h   output usage information

​The profile_name is from incpadMS credentials -n <profile_name>

5. Error code manager

​ You can manage you error code and error info with this command

incpadMS error -h

Usage: error [options]

Options:
  -l,--list                          list all local errors
  -p,--target-path [targetName]      error instance dir
  -c,--create-error [createError]    create a new error
  -t,--template-path [templatePath]  template dir
  -h, --help                         output usage information

• -l option will list all error defines in this project
• -p option just specific the error dir path, default ./src/error/
• -c option just means you want to create a new error, new error will use the template from -t option
• -t option just specific the template file where the error template come from, default ./template/Errors.js.tpl

Author

👤 InceptionPad Inc

• Github: @tanlukang

Show your support

Give a ⭐️ if this project helped you!

This README was generated with ❤️ by readme-md-generator