Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leandrobarbosa753/blog
💬 API Segura com TypeScript, JWT e Prisma
https://github.com/leandrobarbosa753/blog
docker jwt-authentication jwt-authorization jwt-token postgres postgresql prisma typescript
Last synced: 20 days ago
JSON representation
💬 API Segura com TypeScript, JWT e Prisma
- Host: GitHub
- URL: https://github.com/leandrobarbosa753/blog
- Owner: LeandroBarbosa753
- Created: 2024-08-23T19:49:11.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-09T16:07:42.000Z (2 months ago)
- Last Synced: 2024-10-16T12:19:56.472Z (about 1 month ago)
- Topics: docker, jwt-authentication, jwt-authorization, jwt-token, postgres, postgresql, prisma, typescript
- Language: TypeScript
- Homepage:
- Size: 367 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Projeto Blog
## 🔍 Sobre o Projeto
Este projeto é uma API de blog construída com **TypeScript**, **Node.js**, **Express**, **Prisma** e **PostgreSQL**. A seguir estão os passos para configurar o ambiente de desenvolvimento.
## 🛠️ Tecnologias e Ferramentas Utilizadas
## 🐳 Docker
### Comandos Docker Essenciais
Aqui estão alguns comandos Docker úteis para gerenciar imagens e containers no projeto:
- **`docker`**: Mostra todas as opções e subcomandos disponíveis no Docker.
#### Gerenciamento de Containers
- **`docker ps`**: Lista as instâncias de containers que estão rodando no momento.
- **`docker ps -a`**: Lista todas as instâncias de containers, incluindo as que não estão em execução.
#### Gerenciamento de Imagens
- **`docker images`**: Lista todas as imagens Docker disponíveis no sistema.
- **`docker pull postgres`**: Baixa a imagem do Postgres sem iniciar um container.
#### Criação e Remoção de Containers
- **`docker create postgres`**: Cria uma instância do Postgres, baixando a imagem automaticamente se ela não estiver presente no sistema.
- **`docker rm postgres`**: Remove uma instância do Postgres, caso ela exista.
#### Execução de Containers
- **`docker run --name postgres -p 5432:5432 -e POSTGRES_PASSWORD=secret -d postgres`**: Cria e inicia uma nova instância do Postgres, mapeando a porta e definindo a senha de acesso.
## Iniciar Projeto
1. Inicialize o projeto com o comando:
```bash
npm init -y
```
2. Instale as dependências funcionais do projeto, como **[express](https://expressjs.com/)**, **[jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken)** e **[bcryptjs](https://www.npmjs.com/package/bcryptjs)**:
```bash
npm install express jsonwebtoken bcryptjs
```
3. Instale as dependências de desenvolvimento:
```bash
npm install typescript ts-node @types/node --save-dev
```
4. Inicialize o arquivo do TypeScript, o `tsconfig.json`, que é necessário para rodar o TypeScript:
```bash
npx tsc --init
```
## Configurar o **[Prisma](https://www.prisma.io/)**
1. Instale o Prisma como uma dependência de desenvolvimento:
```bash
npm install prisma --save-dev
```
2. Inicialize o Prisma. Isso criará um arquivo `.env` e a pasta `prisma` com as configurações do banco de dados:
```bash
npx prisma init
```
## Configurar o **[PostgreSQL](https://www.postgresql.org/)** com **[Docker](https://www.docker.com/)**
1. Crie um container Docker com o PostgreSQL:
```bash
docker run --name postgres -p 5432:5432 -e POSTGRES_PASSWORD=secret -d postgres
```
2. Acesse o container para interagir diretamente com o PostgreSQL:
```bash
docker exec -it postgres psql -U postgres
```
3. Crie o banco de dados `blog`:
```sql
create database blog;
```
4. No arquivo `.env`, faça as modificações necessárias, ajustando o usuário, senha e o nome do banco de dados:
```
DATABASE_URL="postgresql://postgres:secret@localhost:5432/blog?schema=public"
```
## Configurar o Prisma Schema e Migrações
1. Após configurar os **models** no arquivo `schema.prisma`, realize a primeira migração para criar as tabelas no banco de dados:
```bash
npx prisma migrate dev --name init
```
## Instalar Tipagens e Ferramentas de Desenvolvimento
Durante a importação das bibliotecas **express**, **jsonwebtoken** e **bcryptjs**, observe que elas não possuem tipagem nativa. Portanto, é necessário instalar as tipagens correspondentes como dependências de desenvolvimento:
```bash
npm install @types/express @types/jsonwebtoken @types/bcryptjs --save-dev
```
## Automatizar o Processo de Transpilação do TypeScript
Para evitar transpilação manual do TypeScript sempre que houver uma alteração, instale a biblioteca `tsx` como dependência de desenvolvimento:
```bash
npm install tsx --save-dev
```
Crie um script no arquivo `package.json` para iniciar o projeto em modo de desenvolvimento, com monitoramento automático das mudanças nos arquivos:
```json
"scripts": {
"dev": "tsx watch ./src/main.ts"
}
```
Agora você pode iniciar o projeto com o comando:
```bash
npm run dev
```