✨ sapathanos-sales-server

⚠ Requisitos projeto

Docker
Yarn
Prettier
EditorConfig
ESLint
Veja algumas rotas da api aqui

👩🏻‍💻 Como rodar o projeto?

Digite yarn na raiz para instalar as dependências do projeto.
Digite docker-compose -f docker-compose.yml up --build na raiz para a criação do banco de dados.
Copie os itens do arquivo .env.example e crie um arquivo na raiz do projeto chamado .env com as suas configurações.
Digite yarn typeorm migration:run na pasta raiz para rodar as migrations.
Digite yarn dev:server na pasta raiz para executar o servidor.

🐘 Caso queira usar o PgAdmin (gerenciador de banco Postgres via container)

Execute primeiro o docker-compose -f docker-compose.yml up --build
Acesse http://localhost:16543/ para ter acesso ao banco postgres com o PgAdmin.
Para acessar o PgAdmin:
- Email: admin@admin.com
- Senha: docker

🛑 Padrão de código

Para entender como instalar o EditorConfig, Prettier e ESLint no projeto. Observação: Não é preciso configurá-los novamente, só instalar as extensões e alterar as settings.json do VSCode caso ainda não estejam configuradas. https://www.notion.so/Padr-es-de-projeto-com-ESLint-Prettier-e-EditorConfig-0b57b47a24724c859c0cf226aa0cc3a7

🌐 COMANDOS GIT:

Básicos:

git pull - pega todos os commits do github e atualiza sua branch local
git add . - adiciona as alterações que foram feitas, os arquivos alterados, etc
git add arquivo1.js - adiciona apenas as alterações do arquivo1.js
git commit -m "mensagem aqui" - faz um commit com a mensagem que vc desejar
git push - envia o commit que você fez para o repositório no github

Branch:

git branch - ver em qual branch você está
git checkout branch1 - vai para a branch com o nome: "branch1"
git branch branch2 - cria uma branch com o nome: "branch2"
git checkout -b branch3 - cria uma branch com o nome "branch3" e já entra nela (checkout)
git push -u origin branch1 - para fazer o primeiro push da branch criada, é preciso usar esse comando ou o comando que o github sugerir
git fetch - atualiza no seu pc se alguém criou ou alterou alguma outra branch que você não trabalhava, etc

⚠ IMPORTANTE:

-Antes de começar a desenvolver sempre deve ser feito um pull na branch em que vc está trabalhando, para garantir que ela está sincronizada com o conteúdo do github
-Sempre quando quiser mandar algo para o git precisa seguir a ordem: add > commit > push
-Quando você tiver acabado de testar a sua branch e estiver 100% ok que ela tá pronta, vc entra no github e cria um pull request da sua branch para a main
-Caso surja qualquer dúvida de como fazer alguma coisa, é só me procurar (Tábata)

⚠ NOMES DAS BRANCHES:

A nomenclatura deve seguir o padrão:
-main
-feature/nome-da-funcionalidade (Ex: cadastro-guia)
-fix/nome-do-que-estiver-sendo-consertado (Ex: cadastro-guia-salvando)