1.0.0 • Published 3 years ago

id-prima-disbursement-bank-connector-client v1.0.0

Weekly downloads
-
License
UNLICENSED
Repository
github
Last release
3 years ago

id-prima-disbursement-bank-connector-client

Disbursement bank connector client implementation for Prima

Ownership

Team: Disbursement

Slack Channel: #p-disbursements

Slack Mentions: @troops-disb

Conventions

File Name

We prefer hyphens (kebab-case) this-file-name vs underscores (snake_case) this_file_name

Development

Prerequisite

  • VSCode
  • Node LTS

Start development environment

  • Create .env file or run cp .env.example .env
  • Create .npmrc file or run cp .npmrc.example .npmrc

You can look for the example in the .env.example and .npmrc.example. Paste the actual token in newly created .npmrc file.

.npmrc.example will be where you would put non sensitive npm configs that you would like to be shared across your team.

Testing

Prerequisite

  • Node LTS

Run the test

In order to run unit tests, you can directly execute this command:

npm test

Deployment

  1. Go to https://buddy.tidnex.com/xendit-inc/create-project to create a new project. Click on the repository that you want to import to BuddyWorks.

  2. After you import the repository to BuddyWorks, every commit and PR that you make will trigger a CI (Continuous Integration) Test that will appear on your PR.

  3. To deploy to staging, create a tag release with the version <VERSION>rc, for example v1.0.0-rc.

  4. To deploy to production, create a tag release with the version like <VERSION>, for example v1.0.0.

For more information on the flow for deploying through Github, check out the Github Flow RFC or RFC 13 - Trident