📱 Social Network API

API backend para uma rede social inspirada no Twitter, desenvolvida com NestJS, Prisma e PostgreSQL.

Os usuários podem criar contas, seguir outros usuários, fazer posts com imagens, curtir, comentar e visualizar um feed dinâmico.

---

📘 Documentação da API

Acesse o link acima para a documentação interativa (OpenAPI) completa da API.

---

🚀 Tecnologias e Versões

Badge	Descrição
	Framework principal da aplicação.
	Ambiente de execução JavaScript.
	ORM para banco de dados.
	Banco de dados relacional.
	Autenticação baseada em tokens.
	Armazenamento e manipulação de imagens.
	Serviço de envio de emails.
	Documentação interativa da API.
	Containerização e deploy.

✨ Features

• Autenticação com JWT (login e registro)
  • Autenticação segura com tokens JWT
  • Verificação de email via token
  • Proteção de rotas com Guards e estratégias Passport
• Usuários
  • CRUD de usuários
  • Upload de avatar com Cloudinary
  • Seguir e deixar de seguir outros usuários
  • Perfil personalizado com bio e informações
  • Contagem de seguidores e seguindo
• Posts
  • Criar posts com imagem opcional
  • Atualizar e remover posts (somente o autor)
  • Curtir e descurtir posts
  • Comentar posts, editar e excluir comentários
  • Upload de imagens com Cloudinary
• Feed
  • Visualizar todos os posts
  • Filtrar apenas por posts de usuários seguidos
  • Paginação e ordenação de resultados
• Email
  • Envio de emails de verificação via Resend
  • Templates HTML personalizados
  • Confirmação de conta por email

---

📦 Instalação e uso

1. Clonar o repositório

git clone [https://github.com/santyasm/twii-social-backend.git](https://github.com/santyasm/twii-social-backend.git)
cd twii-social-backend

2. Instalar dependências

# Usando pnpm
pnpm install

# Usando npm
npm install

# Usando yarn
yarn install

3. Configurar variáveis de ambiente

Crie um arquivo .env na raiz do projeto com as variáveis:

DATABASE_URL="postgresql://user:password@host:port/dbname?schema=public"
JWT_SECRET="sua_chave_secreta"
CLOUDINARY_CLOUD_NAME="seu_cloud_name"
CLOUDINARY_API_KEY="sua_api_key"
CLOUDINARY_API_SECRET="sua_api_secret"
RESEND_API_KEY="sua_resend_api_key"
FRONTEND_URL="url_do_frontend"
SMTP_FROM="Twii <no-reply@seudominio.com>"

4. Executar migrações do Prisma

# pnpm
pnpm prisma migrate dev

# npm
npx prisma migrate dev

# yarn
yarn prisma migrate dev

5. Rodar a aplicação em modo dev

# pnpm
pnpm run start:dev

# npm
npm run start:dev

# yarn
yarn start:dev

6. Rodar em produção

Para rodar em produção, primeiro é necessário compilar o projeto (build) e depois iniciá-lo (start:prod):

# Passo 1: Compilar o projeto
pnpm run build
# ou
npm run build
# ou
yarn build

# Passo 2: Iniciar o servidor
pnpm run start:prod
# ou
npm run start:prod
# ou
yarn start:prod

🐳 Usando Docker

Build da imagem

docker build -t twii-social-backend .

Subir o container

docker run -p 3000:3000 --env-file .env twii-social-backend

🔷 Endpoints principais

Autenticação

• POST /auth/register — Registro

• POST /auth/login — Login

• GET /auth/verify-email — Verificação de email

• POST /auth/resend-verification — Reenviar email de verificação

Usuários

• GET /users — Listar todos

• GET /users/:id — Buscar por ID

• PATCH /users/:id — Atualizar usuário

• DELETE /users/:id — Remover usuário

• POST /users/:id/follow — Seguir usuário

• POST /users/:id/unfollow — Deixar de seguir

Posts

• POST /posts — Criar post

• GET /posts — Listar posts

• GET /posts/:id — Buscar post

• PATCH /posts/:id — Atualizar post

• DELETE /posts/:id — Remover post

• POST /posts/:id/like — Curtir post

• POST /posts/:id/unlike — Descurtir post

• POST /posts/:id/comments — Comentar

• PATCH /posts/comments/:id — Editar comentário

• DELETE /posts/comments/:id — Excluir comentário

Feed

• GET /posts/feed — Feed do usuário
  • ?onlyFollowing=true → apenas posts de quem o usuário segue
  • ?onlyFollowing=false → posts sugeridos (todos)
  • ?page=1&limit=10 → paginação de resultados
  • ?orderBy=createdAt&order=desc → ordenação dos resultados

📌 Roadmap

• Sistema de notificações (likes, comentários, novos seguidores)
• Suporte a vídeos nos posts
• Recuperação de senha via email
• Sistema de hashtags e busca por tópicos
• Mensagens diretas entre usuários (chat)
• Implementar refresh token para autenticação mais segura
• Melhorar sistema de recomendações (posts sugeridos)
• Criar testes unitários e de integração (Jest)

👩‍💻 Contribuindo

1. Faça um fork do projeto

2. Crie uma branch para sua feature (git checkout -b feature/nova-feature)

3. Commit suas alterações (git commit -m 'feat: minha nova feature')

4. Faça push para a branch (git push origin feature/nova-feature)

5. Abra um Pull Request 🚀

📜 Licença

Este projeto está sob a licença MIT.

👩‍💻 Autora

Feito com 💜 por Yasmin Santana LinkedIn GitHub