Sobre   |   Tecnologias e ferramentas   |   Features   |   Instalação e execução   |   Como contribuir

📃 Sobre

Este repositório contém o código-fonte original do backend do projeto Plann.er, desenvolvido durante a NLW Journey pela Rocketseat, cuja API foi utilizada para integração e construção do frontend da aplicação.

👉🏻 Repositório do frontend: Frontend Plann.er.

🚀 Tecnologias e ferramentas

Node.js

TypeScript

Prisma

Zod

Nodemailer

✨ Features

A API deste projeto oferece as seguintes funcionalidades:

Viagens

✅ POST /trips: Cria uma nova viagem.
✅ POST /trips/{tripId}/confirm: Confirma uma viagem existente.
✅ PUT /trips/{tripId}: Atualiza os detalhes de uma viagem.
✅ GET /trips/{tripId}: Obtém os detalhes de uma viagem.

Participantes

✅ GET /participants: Obtém a lista de participantes.
✅ GET /participants/{participantId}: Obtém os detalhes de um participante específico.
✅ POST /trips/{tripId}/invites: Cria um convite para um participante.
✅ PATCH /participants/{participantId}/confirm: Confirma a participação de um participante em uma viagem.
✅ DELETE /participants/{participantId}: Remove um participante. *

Atividades

✅ POST /trips/{tripId/activities: Cria uma nova atividade.
✅ GET /trips/{tripId/activities: Obtém a lista de atividades.
✅ PUT /trips/{tripId/activities/{activityId}: Atualiza os detalhes de uma atividade. *
✅ DELETE /activities/{activityId}: Remove uma atividade. *

Links

✅ POST /links: Cria um novo link.
✅ GET /links: Obtém a lista de links.
✅ PUT /links/{linkId}: Atualiza os detalhes de um link. *
✅ DELETE /links/{linkId}: Remove um link. *

* - Novos endpoints adicionados.

🔧 Instalação e execução

Para baixar o código-fonte do projeto em sua máquina, primeiramente terá que ter instalado o Git. Com o Git instalado, em seu terminal execute o seguinte comando:

git clone https://github.com/mathrb22/nlw-journey-nodejs.git

Para instalar as dependências e executar o projeto terá que ter instalado em sua máquina o node.js, que vem acompanhado do npm. Instale as dependências usando o comando abaixo:

npm install

Antes de executar o projeto copie o conteúdo do arquivo .env.example para um novo arquivo chamado .env e preencha as variáveis de ambiente com os valores correspondentes.

Execute o projeto:

npm run dev

A API estará disponível em http://localhost:3333.

Para rodar as migrations do banco de dados, execute o comando:

npx prisma migrate dev

Para executar o Prisma Studio e visualizar os dados do banco de dados, execute o comando:

npx prisma studio

💡 Como contribuir

• Faça um fork desse repositório;
• Crie um branch para a sua feature: git checkout -b minha-feature;
• Faça um commit com suas alterações: git commit -m 'feat: Minha nova feature';
• Faça um push para o seu branch: git push origin minha-feature;
• Faça um pull request com sua feature;

Pull requests são sempre bem-vindos. Em caso de dúvidas ou sugestões, crie uma issue ou entre em contato comigo.