[![codecov-b](https://codecov.io/gh/N2BBrasil/my_nutri/branch/develop/graph/badge.svg?token=LJWJCT6LQU)](https://codecov.io/gh/N2BBrasil/my_nutri)
# MyNutri

Nutrição nunca foi tão fácil

## Getting Started

### Setup

- [Install yarn](https://yarnpkg.com/)
- [Install docker for mac](https://docs.docker.com/docker-for-mac/install/)
- [Install Hasura CLI version v2.0.0-alpha.10](https://hasura.io/docs/latest/graphql/core/hasura-cli/install-hasura-cli.html#install-hasura-cli)

#### M1 machines
- [Install docker for mac](https://docs.docker.com/docker-for-mac/apple-m1/)
- [Install Hasura CLI node version](https://hasura.io/docs/1.0/graphql/core/hasura-cli/install-hasura-cli.html#install-through-npm)
- Increase the docker memory to 6GB

#### Hasura Configure
- If needs to change default configuration for Hasura (ports, admin secret, etc..), duplicate `.env.example` file and rename it for `.env`.
- Done, just change the configurations.

## Run

- `yarn start`: Start Hasura and serverless.
- `yarn hasura:up`: Start Hasura Docker container.
- `yarn hasura:start`: Start Hasura and apply metadata and migrations.
- `yarn hasura:stop`: Stop Hasura.
- `yarn hasura:console`: Open Hasura Console.
- `yarn backend:start`: Start serverless functions.
- `yarn backend:deploy`: Deploy serverless functions.

### Cli

The commands will available only on `serverless/users` folder.

- `[ENV=stag] yarn console [command] [args]`. 
    Ex.: `yarn console patients updateExtraData '2022-05-01' '2022-06-01'`

## [Hasura](https://hasura.io/docs/latest/graphql/core/getting-started/index.html)
All config files, metadata and migrations created are in `./hasura` folder. Current version is:
- `v2.2.0`

## [Serverless](https://www.serverless.com/)
The serverless functions are in `./serverless` folder separated by microservice:
- `users`: for now, there are only microservice with all project functions.
## Libs Folder
When has a big size 3-party library its added in `./libs` folder with package.json configured for to be possible shared with serverless functions and also created a specific serverless layers for it. 

## [Heroku](https://www.heroku.com/)
### Manual Deploy
Uses when has a new Hasura version:

- `git push heroku master`

## Commit Messages

### Git Commit Guidelines

- Follow the [Conventional Commits](https://conventionalcommits.org/)
- Follow the [Angular Commit Message Guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines)

- Follow the [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) tips
- Follow the [5 Useful Tips For A Better Commit Message](https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message) tips
- Consider using [Commitizen cli](http://commitizen.github.io/cz-cli/)

### Follow [The seven rules of a great Git commit message](https://chris.beams.io/posts/git-commit/) (TL;DR)

1. [Separate subject from body with a blank line](https://chris.beams.io/posts/git-commit/#separate)
2. [Limit the subject line to 50 characters](https://chris.beams.io/posts/git-commit/#limit-50)
3. [Capitalize the subject line](https://chris.beams.io/posts/git-commit/#capitalize)
4. [Do not end the subject line with a period](https://chris.beams.io/posts/git-commit/#end)
5. [Use the imperative mood in the subject line](https://chris.beams.io/posts/git-commit/#imperative)
6. [Wrap the body at 72 characters](https://chris.beams.io/posts/git-commit/#wrap-72)
7. [Use the body to explain what and why vs. how](https://chris.beams.io/posts/git-commit/#why-not-how)

### Commit Types

As configured on [`.commitlintrc.yml`](https://commitlint.js.org/#/reference-configuration), it must be one of the following:

- **feat**: A new feature
- **fix**: A bug fix
- **docs**: Documentation only changes
- **ref**: A code change that neither fixes a bug nor adds a feature
- **test**: Adding missing tests or correcting existing tests
- **revert**: A commit that reverts a previous commit
- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
- **ci**: Changes to our CI configuration files and scripts _(example scopes: Circle, BrowserStack, SauceLabs)_
- **build**: Changes that affect the build system or external dependencies _(example scopes: gulp, broccoli, npm)_
- **perf**: A code change that improves performance
- **git**: Changes on git files, such as [`.gitignore`](https://git-scm.com/docs/gitignore)

### Commit Best Practices

- Commit [often](https://sethrobertson.github.io/GitBestPractices/#sausage_metaphor)
- Keep commits small and [atomic](https://www.freshconsulting.com/atomic-commits/)
- Write [S.O.L.I.D.](https://youtu.be/e9K1gHYIE2c) commits
- Write meaningful titles targeting for non-technical readers
- Write commits that would help the Code Review
- Add any extra information that would help the Code Review
- Reference the [issue](https://help.github.com/en/articles/autolinked-references-and-urls) that originated the commit

## References

- [Hasura](https://docs.hasura.io/1.0/graphql/manual/index.html) - Get realtime GraphQL APIs instantly
- [Migrations](https://docs.hasura.io/1.0/graphql/manual/migrations/new-database.html) - Migrations for a new database and Hasura instance
- [PostgreSQL](https://www.postgresql.org/) - The World's Most Advanced Open Source Relational Database
- [NestJs](https://nestjs.com/) - A progressive Node.js framework for building efficient, reliable and scalable server-side applications.
- [NestJs-Console](https://github.com/Pop-Code/nestjs-console) - A ready to use service class for your modules that exposes methods to register commands and sub commands using [commander](https://www.npmjs.com/package/commander)
- [Serverless](https://www.serverless.com/) - Provide full serverless application lifecycle management.
- [Rollbar](https://docs.rollbar.com/docs/nodejs) - Rollbar provides real-time exception reporting and continuous deployment monitoring for developers
- [Jest](https://jestjs.io/pt-BR/) - Javascript Testing Framework with a focus on simplicity
- [Faker](https://github.com/faker-js/faker) - Generate massive amounts of fake (but realistic) data for testing and development.
- [FactoryBot](https://github.com/ratson/factory-bot#readme) - A factory library for Node.js