https://github.com/smoothemerson/plann.er_backend

Project given by Rocketseat in NLW JOURNEY event.
https://github.com/smoothemerson/plann.er_backend

fastify prisma typescript zod

Last synced: about 2 months ago
JSON representation

Project given by Rocketseat in NLW JOURNEY event.

• Host: GitHub
• URL: https://github.com/smoothemerson/plann.er_backend
• Owner: smoothemerson
• Created: 2024-07-10T20:58:20.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-23T22:44:31.000Z (5 months ago)
• Last Synced: 2024-10-12T02:42:16.922Z (2 months ago)
• Topics: fastify, prisma, typescript, zod
• Language: TypeScript
• Homepage: https://nlw-journey.apidocumentation.com/reference
• Size: 73.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Plann.er API

Backend da aplicação Plann.er, uma plataforma para gerenciamento de viagens.

## 🛠 Tecnologias

As principais ferramentas usadas no desenvolvimento do projeto são:

- **[TypeScript](https://www.typescriptlang.org/)**: Linguagem para desenvolvimento com tipagem estática.

- **[Fastify](https://fastify.dev/)**: Framework web rápido e leve para Node.js.

- **[Prisma](https://www.prisma.io/)**: ORM para gerenciamento de banco de dados.

- **[Zod](https://zod.dev/)**: Biblioteca para validação de esquemas.

- **[Nodemailer](https://nodemailer.com/)**: Biblioteca para envio de e-mails.

- **[DayJS](https://day.js.org/)**: Biblioteca para manipulação de datas.

> Para detalhes sobre as dependências gerais da aplicação, consulte o arquivo [package.json](./package.json).

## ⚙ Setup

### 📝 Requisitos

Certifique-se de ter as seguintes ferramentas instaladas:

- [Git](https://git-scm.com)

- [NodeJS](https://nodejs.org/en/)

- [NPM](https://www.npmjs.com/), [PNPM](https://pnpm.io/pt/) ou [Yarn](https://yarnpkg.com/)

Além disso, é recomendável usar um editor de código, como [VSCode](https://code.visualstudio.com/).

Para testar as rotas da aplicação, você pode usar o cliente HTTP [Postman](https://www.postman.com/).

### Clonando e Executando

Siga estes passos para clonar e executar a aplicação localmente:

```bash

# Clone este repositório

$ git clone [email protected]:smoothemerson/plann.er_backend.git

# Acesse a pasta do projeto no terminal

$ cd plann.er_backend

# Instale as dependências

$ npm install

# Crie o arquivo '.env' e preencha as variáveis conforme o arquivo '.env.example'

# Execute as migrations para criar as tabelas necessárias no banco

$ npx prisma migrate-dev

# Execute a aplicação em modo de desenvolvimento

$ npm run dev

# A aplicação iniciará na porta configurada no arquivo '.env'

```



  Feito com 💜 por Emerson Rocha 👋🏽 Entre em contato!