Pode crer backend

Tópicos

Introdução
Quais as tecnologias usamos no projeto
Como rodar o projeto
Como contribuir?
- fiz um fork como pegar as atualizações?

Introdução

A ideia do projeto é construir uma api para um sistema de crowdfunding. Nesse api podemos fazer ações básicas como criação de usuário, autenticação, criação de sonhos ( é assim que chamamos as campanhas de cada um ) e até mesmo coisas um pouco mais complexas como doações, envio de email via SMTP e armazenar as imagens dos sonhos em um serviço de storage dedicado

Quais as tecnologias usamos no projeto

Como rodar o projeto

Para executar esse projeto você deve ter em sua maquina:

NodeJs ( desenvolvido com node na versão 12+ )
Uma conta gratuita no firebase
Uma conta gratuita em algum serviço de smtp ( recomendamos o mailtrap ou ethereal )
Conhecimento básico sobre variáveis de ambiente com arquivo ".env" ( material de apoio )

Primeiro passo

Instale as depêndencias do projeto com o comando

npm install

Agora devemos "cadastrar" algumas variáveis para nossa aplicações funcionar corretamente
- Copie e cole na raiz do projeto o arquivo ".env.example", em seguida renomeie para ".env". Lembre-se que esse arquivo não vai para o versionamento pois trata-se de informações sensíveis.
- defina um valor para PORT, pode ser 3000, 8001 ou alguma de sua preferênia
- Com a conta gratuita do firebase criada devemos gerar as chaves da conta de serviço, veja essa issue
- Agora precisamos configurar os valores de JWT_SECRET e JWT_EXPIRES, recomendamos usar valores de 7d e usar um hash para o secret esses valores são usadoas para validação do token de autenticação e para gerar/comparar o hash de senha
- agora precisamos das chaves do nosso serviço smtp, na dashboard do mailtrap exista a opção de integrações basta seleciona nodejs/nodemailer o valor do host vai para MAIL_HOST, port para MAIL_PORT, user para MAIL_USER, pass para MAIL_PASS. O valor MAIL_DEFAULT é um email aonde todos os email serão enviados recomendamos fazer seu uso.
Tenha em mente que a serviço gratuito do *mailtrap* pode ser visualizado apenas na plataforma deles portanto devemos fazer uso da dashboard para visualizar os email enviados.

Segundo passo

Agora podemos executar um dos script de execução

npm run dev

é válido ressaltar que nosso projeto faz uso do nodemon para live-reload

Como contribuir

Primeiro faça um clone do projeto

  git clone https://github.com/Vitor-Vaz/pode-crer-backend.git

Agora crie uma nova branch com o seu nome ou com a feature que você deseja criar/corrigir. Uma abordagem é o git branch + git switch

  git branch NOME-DA-BRANCH
  git switch NOME-DA-BRANCH

Você tambem pode fazer

  git switch -C NOME-DA-BRANCH

  git checkout -b NOME-DA-BRANCH

Faça todas as modificações necessárias e de o commit

  git commit -m "implemetação da funcionalidade X"

Se você encontrou algua issue relacionado você pode criar um link na tua mensagem de commmit usando '#' seguido pelo numero da issue. Dessa forma o commit será linkado automaticamente na issue 😃

  git commit -m "implemetação da funcionalidade X #25"

Após o(s) commit(s), basta enviar as modificações para o servidor

  git push origin NOME-DA-BRANCH

Como pegar atualizações a partir de um fork

Se você optou por fazer um fork saiba que ele funciona como um novo repositório, isso quer dizer que o "endereço" do origin é diferente do repositório de origem.

Uma abordagem interessante é você adicionar uma "remote url", abaixo deixo uma sugestão

  git remote add repoOriginal https://github.com/Vitor-Vaz/pode-crer-backend.git

agora quando você pode dar pull diretamente do repositorio original.

  git pull repoOriginal NOME-DA-BRANCH

Se você quiser pegar uma atualização do branch main pode fazer algo do tipo

  git pull repoOriginal main

O mesmo se aplica para o push... mas... nesse caso o ideal é fazer um pullrequest... mas se ainda sim você quiser podes fazer algo do tipo

  git push repoOriginal NOME-DA-BRANCH

**O ideal é nunca commitar diretamente na branch main, eu dei um exemplo **

Vitor-Vaz / pode-crer-backend