@NewSchool/back

Backend da NewSchool, desenvolvido em NodeJS Banco de Dados MySQL

Como rodar o projeto

Você pode rodar o projeto direto da sua máquina.

1 - Tenha a versão 12 do Node.js instalada em sua máquina.

2 - Faça uma cópia do arquivo .env.example para .env

3- Instale as depedências do projeto

npm install

4- Inicie a aplicação

npm run start:dev

5- Veja o swagger pelo navegador

http://localhost:8080/swagger

Docker

Ou, você pode optar por rodar o projeto via Docker. Para isso precisamos que você tenha instalado o Docker na sua máquina. Após isso basta rodar o seguinte comando:

docker-compose up

E o ambiente de desenvolvimento estará rodando localmente para você. Lembrando que estamos com o hot reloading no Docker também, ou seja, você não precisará ficar parando o container e subindo ele novamente a cada mudança que você fizer. Isso acontecerá automaticamente.

5- Para executar os teste E2E execute o script abaixo

npm run test:e2e

Guidelines

Como contribuir passo-a-passo

1 - CONHEÇA O PROJETO New School

https://youtu.be/u4O8wE0gYO0

2 - ENTRE NO SLACK

https://join.slack.com/t/newschoolgrupo/shared_invite/enQtODQ4NjUyMjAzNTUzLTg3NTJiNmQ1ODE3YzYzMjcyYzVhYTNkZjIzYjViMjI4NTBjYzFiYTc3Njg0ZWI3YTk2MjE5NDY3MDlkYzViOGI

2.1 - LÁ NO SLACK, ENTRE NO CANAL #BACKEND

• Se apresente. Nome, cidade, profissão, e principais habilidades.
• Pergunte sobre as tarefas em aberto.
• Troque uma ideia com o time técnico. Comente como planeja solucionar. Ouça os conselhos dos devs mais experientes. Esse alinhamento é super importante pra aumentar significativamente as chances do seu PULL REQUEST ser aprovado depois.

3 - FAÇA PARTE DA EQUIPE NO TRELLO

https://trello.com/invite/b/2MHuWn0C/b1a15b7112ea11b856cfa78174a6f72d/projeto-new-school-app

3.1 - PEGUE UMA TAREFA NO TRELLO.

• https://trello.com/b/2MHuWn0C/projeto-new-school-app
• Coloque no seu nome e mova para DOING.

4 - GITHUB

4.1 FAÇA UM FORK DO REPOSITÓRIO

https://github.com/NewSchoolBR/newschool-backend

4.2 ESCREVA CÓDIGO

Hora de colocar a mão na massa. A parte mais divertida, trabalhar no código-fonte. Depois de concluir e testar, envie e aguarde o PULL REQUEST ser aprovado.

5 MISSÃO CUMPRIDA. VC AJUDOU O PROJETO. ❤️

🤝 Como contribuir

Nós precisamos muito de contribuidores! Não importa o seu nível, o que importa é nos ajudar nessa causa.

Se você quer participar, veja nosso Guia de contribuição.