https://github.com/gabrielgpavao/kenzie-desafio-tech-backend
https://github.com/gabrielgpavao/kenzie-desafio-tech-backend
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gabrielgpavao/kenzie-desafio-tech-backend
- Owner: gabrielgpavao
- Created: 2023-05-24T14:57:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-29T17:14:41.000Z (almost 2 years ago)
- Last Synced: 2025-01-05T12:41:50.672Z (5 months ago)
- Language: TypeScript
- Size: 50.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 1. Início Rápido
### 1.1. Instalando Dependências
Clone o projeto em sua máquina e instale as dependências com o comando:
Caso use npm
```bash
npm install
```
Caso use yarn
```bash
yarn
```
### 1.2. Variáveis de Ambiente
Em seguida, crie um arquivo **.env**, copiando o formato do arquivo **.env.example**:
```
cp .env.example .env
```
Configure suas variáveis de ambiente com suas credenciais do PostgreSQL e um novo Banco de Dados da sua escolha.
Além disso, insira uma valor aleatório à variável de chave secreta ("SECRET_KEY") que irá compor o token JWT.
### 1.3. Migrations
Execute as migrations com o comando:
```bash
npx prisma migrate dev --name init
```
---
### 1.4. Inicialização do Servidor
Inicie o servidor localmente com o comando:
Caso use npm
```bash
npm run start:dev
```
Caso use yarn
```bash
yarn start:dev
```
## 2. Documentação da API
A documentação da API foi feita com o Swagger e está localizada na rota `/api` da url base.
```
http://localhost:3001/api
```