bms-api v1.0.0

bms-api

Dependencies to run the project

• NodeJS v10^

Technologies

• TypeScript
• NodeJS

Installation

  > git clone git@github.com:OpenCircleTech/bms-api.git
  > cd bms-api
  > yarn install || npm install

Settings

You must then create a file called ".env", followed by the pattern specified in .env.example

To run the project

   > yarn dev // Dev || npm run dev

Contribute to the project

• To contribute to the project, it is necessary to have the source code updated with the branch Master
• Create a branch from the git checkout -b nameDaBranch - e.g. listUser
• Develop the functionality in this branch created
• Make the commits git add . and git commit -m 'description of what was done'
• Upload to the repository your git push origin branch namedDaBranch
• Open a Pull request to the master, describing what has been changed