nutria-system

Pre requisites

1. Nodejs
2. Firebase CLI
3. Standardjs (Install it globally)

Setup

1. Change your current directory to functions folder and run:

   npm install

2. Change the permissions of the pre-commit file:

   chmod +x pre-commit
   

3. Move the pre-commit file to the .git/hooks folder

Development

Test out your functions locally using:

firebase serve

Deployment

Deploy all the functions using:

firebase deploy

Remember to update the security rules in the webpage of the project using Firebase's recommendations and the data indexes using Firebase's guide.

Important Notes

Commit Messages

Use the following rule to write your messages:

This commit will: <commit message>

Examples:

This commit will: Test the NutriaUser endpoint using jest

Note: Remember to capitalize the first letter of the message.

Tasks

All the available task are located inside the board, remember to upload the status of your task to show others what has been done.

Ignored files

Please don't commit personal editor's configuration (e.g. .vscode), you shouldn't push your personal settings to the repo in order to not confuse other contributors.