## Node API boilerplate
### Purpose
We plan to create a boilerplate for the nodejs API. For any project we need to do few basic things before we start the project,
- Create a repository
- Add basic information of the API
- Add a readme file
- Create the folder structure
- Add initial route for the API
- Add few utilities which are used heavenly
- Logging mechanism etc
- Code linting setup

The purpose of this component is to ensure that we have all these requirement bundled together so that these things are not repeated for every project.
Any component which we want to create will use this as the fundamental foundation.

### Tasks

Though most of this is already covered in caleido boilerplate still we found few issues/features needed while using the framework and we would like to fix these issues in out boilerplate.

| Task | Estimate (hours) |
| ------ | ------ |
| Clone boilerplate from caleido azure repository. | 2 |
| Migrate from node 10 to node 12 | 4 |
| Add latest query helper code | 6 |
| Create a separate repository for ENV | 8 |
| Create a separate repository for logger | 8 |
| Create a separate repository for excel | 8 |
| Create a separate repository for PDFUtil | 8 |
| Create a separate repository for file.util | 8 |
| Add updated util code(excel.js with latest features) | 8 |
| Get rid of caleido keyword from the repo (code, filename etc) | 8 |
| Copy latest features from "facility-manager" (Azure) | 8 |
| Update README file | 8 |
| Add different test cases skeleton/sample for these util methods | 16 |
| Total | 88|

### Clone boilerplate from caleido azure repository.

#### Description
* Clone the node-boilerplate from this AZURE and change the remote url to `[e-mail]:osm-nodejs/node-boilerplate.git` in the git config file so that all the commits will go inside the gitlab's node-boilerplate.

### Migrate from node 10 to node 12
#### Description
* Make sure Node 12 is installed and is current version.
* Make sure that application is working on node 12 version
* Verify that components are running fine, if issues are found update code as per the need.

### Add latest query helper code
#### Problem
* As of now in node-boilerplate query helper code is not updated.
#### Description
* we've included helper functions to make creating certain queries quicker and easier.
* For example in caleido we used addComplexWhere, addPagination methods in queryHelper to reduce the code duplication.
* Need to update the query helper code in the node-boilerplate.
* Get the commits from the azure and directly update the code and change the code if needed.

### Create a separate repository for ENV
#### Description
* Create a separate repository for the ENV.
* All the env related methods present in the env repository and those are being imported into the node-boilerplate by installing the env repository as a module.

### Create a separate repository for logger
#### Description
* Create a separate repository for the logger.
* All the logger related methods present in the logger repository and those are being imported into the node-boilerplate by installing the logger repository as a module.

### Create a separate repository for excel
#### Description
* Create a separate repository for the excel.
* All the excel related methods present in the excel repository and those are being imported into the node-boilerplate by installing the excel repository as a module.

### Create a separate repository for PDFUtil
#### Description
* Create a separate repository for the PDFUtil.
* All the PDFUtil related methods present in the PDFUtil repository and those are being imported into the node-boilerplate by installing the PDFUtil repository as a module.

### Create a separate repository for file.util
#### Description
* Create a separate repository for the util file.
* All the util file related methods present in the util file repository and those are being imported into the node-boilerplate by installing the util file repository as a module.

### Add updated util code(excel.js with latest features)
#### Problem
* As of now excel repository didn't contain the latest code.
#### Description
* Need to update the excel code in the excel repository.
* Get the latest code from the faciliti-manager repository from the AZURE and update the excel code.

### Get rid of caleido keyword from the repo (code, filename etc)
#### Description
* we should not use the client project related keywords in our repository like caledio, facilti.
* Make sure to remove everywhere which are related to caleido from the node-boilerplate repository.

### Copy latest features from "facility-manager" (Azure)
#### Description
* Add the latest features to the node-boilerplate
* Some of the features are missing in the node-boilerplate so we need to copy the latest features from the facility-manager and then paste them in the node-boilerplate. Make sure everything is working fine after changing the code with latest features.

### Update README file
#### Description
* Update the readme as per the latest changes in the node-boilerplate repository

### Add different test cases skeleton/sample for these util methods
#### Description
* Need to write some test cases for the methods which are present in the util folder and make sure that all the test cases should pass.

**Note:** As of now we are considering it as low priority task.