Wallet service with CIO CI/CD

Initial code to create an API service. This code contains:

• A node.js server
• An express framework implementation
• A static code analysis tool (eslint)
• A code formatter (prettier)
• API documentation (Swagger)
• API Authentication and Authorication with json web tokens (security module)
• A logger module (Winston)
• A testing suite tool (Jest)

Initial setup

Download required tools

To begin working, you'll require certain tools.

1. Download and install Node.js (LTS).
2. Download and install a code editor (the recommended one is Visual Studio Code).
3. You will require a 1Password account to access the environment files. Create one if you don't have already.

Set up the project with git and npm

1. Make sure you have git or an equivalent software (i.e. GitHub Desktop) installed on your computer.
2. Login with your enterprise IBM GitHub account or connect with an SSH key (recommended).
3. Clone this repository (SSH): git clone [email protected]:Global-HR-EMEA/api-skeleton.git
4. Go to the root directory of the project, and run the following command (this will install all required modules): npm i

Add the environment file

1. Request access to the project's 1Password vault:

In order to obtain the .env file required for this project please request access to the 1password vault to any of the following contacts.

• @ahtziri.fernandez1
• @Bernardo Elizondo

2. Get the api-skeleton.env file and put it on the root directory of this project.
3. Remove the api prefix, renaming it to .env.

• To run test cases use the following command: npm run test-coverage
• To run the application on a local environment is recommended to use npm run dev this will allow you to use a tool called nodemon to quickly perform changes, save them and test them out without requiring to restart the server each time.