🍷 COMO UTILIZAR

Primeiro, você precisa ter o NodeJS instalado na sua máquina.

Se você estiver utilizando o Linux, você pode optar por instalar o Node através do gerênciador de versões nvm para facilitar o processo de mudança da versão do Node, quando for necessário.

Você pode optar também por utilizar o yarn no lugar do npm. Você pode instalar clicando neste link.

Após ter o Node instalado, instale as dependências contidas nos arquivos package.json que se encontram na raíz do repositório (para o gerenciamento de commits), no diretório do server. Para instalar as dependências, basta abrir o terminal no diretório e digitar o comando:

$ yarn
ou
$ npm install

Em ambiente de desenvolvimento, podemos utilizar o Docker para criar o nosso servidor.

Instale a imagem do postgres em seu docker com o seguinte comando:

docker pull postgres:alpine

Após instalar a imagem, inicie o servidor:

# exemplo
docker run --name postgres-0 -e POSTGRES_PASSWORD=password -d -p 5432:5432 postgres:alpine

Você precisará criar um arquivo na raíz do projeto chamado .env com o link do banco de dados (postgres) e a chave secreta do token.

Dentro do arquivo coloque:

# exemplo
DATABASE_URL="postgres://postgres:password@localhost:5432/postgres"
SECRET="ADAWDWADWAFA"

Agora você precisará criar o seu banco de dados, e o prisma facilita isso com o comando:

npx prisma db push

Após ter instalado todas as dependências e criado o arquivo com a chave de requisição, você poderá gerar a build do servidor para o seu dispositivo com:

$ npm run dev

COMO CONTRIBUIR

• Verifique as Issues que estão abertas e se já não existe alguma com a sua feature;
• Abra uma Issue com o nome e descrição da sua feature e assine com o seu usuário informando que irá fazê-la;
• Faça um fork do repositório;
• Entre no sua página do GitHub e faça um clone do seu fork;
• Crie uma branch com o nome da sua feature: git chechout -b feat/minhaFeature;
• Faça as alterações necessárias no código ou na documentação;
• Instale as dependências do commitlint na raíz do projeto para a verificação dos commits: npm install ou yarn;
• Faça o commit das suas alterações seguindo as convenções de commit, adicione na descrição o id da sua Issue em parênteses e lembre de fechar a sua Issue com o id no rodapé do commit:

  <tipo>(escopo opcional): <descrição> (#x)

  [corpo do commit]

  Close #x

Exemplo:

  feat: adicionado componente para tal coisa (#52)

  Foi adicionado um componente para tal coisa com o objetivo de melhorar tal coisa, deixando o projeto de tal maneira.

  Close #52

• Faça um push para a sua branch: git push origin feat/minhaFeature;
• Agora é só abrir um pull request no repositório que você fez o fork e assim que acontecer o merge sua Issue será fechada e suas alterações irão fazer parte do projeto;
• Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

* Obrigado por contribuir! ❤️ 👊 😊