Skip to content
/ API-forum-simples Public

Uma api simples que utilizei para um projeto em React Native, ela usa Nest JS e postgreSQL, O ORM utilizado foi o typeORM.

api-forum-simples.vercel.app
0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

gabrielanacletoo455/API-forum-simples

BranchesTags

Repository files navigation

🚀 CondfyNews API - Fórum de Desenvolvedores

API REST para fórum de desenvolvedores criada para fins de estudo e prática com React Native

Uma API completa e funcional para um fórum de desenvolvedores, construída com NestJS,TypeORM , TypeScript e PostgreSQL. Esta API foi desenvolvida como projeto de estudo para aprender React Native, fornecendo um backend robusto para uma aplicação mobile de fórum.

📋 Índice

🎯 Sobre o Projeto

Esta API foi criada para servir como backend para uma aplicação mobile de fórum de desenvolvedores. O objetivo principal é fornecer uma base sólida para estudos de React Native, oferecendo funcionalidades completas de um fórum moderno.

✨ Funcionalidades Principais

  • 👥 Sistema de Usuários: Cadastro, login, perfis e gerenciamento
  • 📝 Posts: Criação, edição, exclusão e listagem de posts
  • 💬 Comentários: Sistema completo de comentários nos posts
  • 🔍 Busca: Busca por posts e conteúdo
  • 🔐 Autenticação: JWT com controle de acesso baseado em roles

🛠️ Tecnologias Utilizadas

  • NestJS - Framework Node.js para APIs
  • TypeScript - Tipagem estática
  • PostgreSQL - Banco de dados relacional
  • TypeORM - ORM para TypeScript com migrations automáticas
  • JWT - Autenticação e autorização
  • Swagger - Documentação automática da API
  • Class Validator - Validação de dados
  • Bcrypt - Criptografia de senhas

🗄️ TypeORM - Gerenciamento de Banco de Dados

O projeto utiliza TypeORM como ORM principal, oferecendo:

  • 🔄 Migrations Automáticas: Controle de versão do banco de dados
  • 📊 Relacionamentos: One-to-Many, Many-to-One entre entidades
  • 🔍 Queries Otimizadas: Consultas eficientes com joins automáticos
  • 🛡️ Type Safety: Tipagem completa das entidades e queries
  • ⚡ Performance: Lazy loading e eager loading inteligente

🚀 Como Iniciar o Projeto

📋 Pré-requisitos

  • Node.js (versão 18 ou superior)
  • PostgreSQL (versão 12 ou superior)
  • npm ou yarn

🔧 Instalação

  1. Clone o repositório
git clone https://github.com/gabrielanacletoo455/API-forum-simples
cd CondfyNews
  1. Instale as dependências
npm install
# ou
yarn install
  1. Configure as variáveis de ambiente
# Crie um arquivo .env na raiz do projeto
cp .env.example .env
  1. Configure o banco de dados
# Configure as variáveis no arquivo .env
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_USERNAME=seu_usuario
DATABASE_PASSWORD=sua_senha
DATABASE_NAME=condfynews
  1. Inicie o servidor
npm run start:dev
# ou
yarn start:dev

🌐 Acessando a API

📚 Documentação da API

🔗 Acessando o Swagger

Acesse a documentação interativa da API em:

http://localhost:3000/docs

O Swagger fornece:

  • 📖 Documentação completa de todos os endpoints
  • 🧪 Interface para testar as rotas
  • 📝 Exemplos de requests e responses
  • 🔐 Teste de autenticação integrado

🔗 Endpoints Disponíveis

👥 Usuários (/users)

  • POST /users - Criar usuário
  • GET /users - Listar usuários
  • GET /users/:id - Buscar usuário por ID
  • PATCH /users/:id - Atualizar usuário
  • DELETE /users/:id - Excluir usuário

🔐 Autenticação (/auth)

  • POST /auth/login - Login do usuário
  • POST /auth/register - Registro de usuário

📝 Posts (/posts)

  • POST /posts - Criar post (🔐 Autenticado)
  • GET /posts - Listar todos os posts
  • GET /posts/search - Buscar posts
  • GET /posts/my-posts - Meus posts (🔐 Autenticado)
  • GET /posts/myposts/:id - Posts por autor (🔐 Autenticado)
  • GET /posts/my-commented - Posts que comentei (🔐 Autenticado)
  • GET /posts/:id - Buscar post por ID
  • PATCH /posts/:id - Atualizar post (🔐 Autenticado + Ownership)
  • DELETE /posts/:id - Excluir post (🔐 Autenticado + Ownership/Admin)

💬 Comentários (/comments)

  • POST /comments - Criar comentário (🔐 Autenticado)
  • GET /comments - Listar todos os comentários
  • GET /comments/:id - Buscar comentário por ID
  • PATCH /comments/:id - Atualizar comentário (🔐 Autenticado + Ownership)
  • DELETE /comments/:id - Excluir comentário (🔐 Autenticado + Ownership/Admin)

🔐 Autenticação

📝 Como Autenticar

  1. Registre um usuário:
POST /auth/register
{
  "userName": "gabriel-dev",
  "email": "gabriel@dev.com",
  "password": "123456"
}
  1. Faça login:
POST /auth/login
{
  "email": "gabriel@dev.com",
  "password": "123456"
}
  1. Use o token:
Authorization: Bearer <seu_token_jwt>

🔑 Roles Disponíveis

  • client - Usuário comum (padrão)
  • admin - Administrador (acesso total)

📱 Estrutura do Projeto

src/
├── auth/                    # Autenticação e autorização
│   ├── decorators/         # Decorators customizados
│   ├── guards/             # Guards de autenticação
│   ├── jwt/                # Configuração JWT
│   └── dto/                # DTOs de autenticação
├── users/                  # Módulo de usuários
│   ├── entities/           # Entidade User
│   ├── dto/                # DTOs de usuário
│   └── docs/               # Documentação Swagger
├── posts/                  # Módulo de posts
│   ├── entities/           # Entidade Post
│   ├── dto/                # DTOs de post
│   └── docs/               # Documentação Swagger
├── comments/               # Módulo de comentários
│   ├── entities/           # Entidade Comment
│   ├── dto/                # DTOs de comentário
│   └── docs/               # Documentação Swagger
├── database/               # Configuração do banco
└── main.ts                 # Arquivo principal

🎯 Funcionalidades do Fórum

📝 Posts

  • Criação de posts com título, conteúdo e imagem opcional
  • Edição e exclusão (apenas pelo autor ou admin)
  • Busca por título e conteúdo
  • Listagem ordenada por data

💬 Comentários

  • Comentários em posts
  • Edição e exclusão (apenas pelo autor ou admin)
  • Relacionamento com posts e usuários

👥 Usuários

  • Perfil completo com informações pessoais
  • Sistema de roles (client/admin)
  • Gerenciamento de dados pessoais

🔍 Busca

  • Busca por posts
  • Filtros por autor
  • Ordenação por relevância e data

🗄️ Estrutura do Banco de Dados (TypeORM)

📊 Entidades Principais

👤 User (Usuários)

- id: number (PK)
- userName: string
- email: string
- password: string (hash)
- role: 'client' | 'admin'
- posts: Post[] (One-to-Many)
- comments: Comment[] (One-to-Many)

📝 Post (Posts)

- id: number (PK)
- title: string
- content: string
- imageUrl: string (opcional)
- authorId: number (FK)
- author: User (Many-to-One)
- comments: Comment[] (One-to-Many)

💬 Comment (Comentários)

- id: number (PK)
- content: string
- authorId: number (FK)
- postId: number (FK)
- author: User (Many-to-One)
- post: Post (Many-to-One)

🔗 Relacionamentos TypeORM

  • User → Posts: One-to-Many (um usuário pode ter vários posts)
  • User → Comments: One-to-Many (um usuário pode ter vários comentários)
  • Post → Comments: One-to-Many (um post pode ter vários comentários)
  • Post → User: Many-to-One (um post pertence a um usuário)
  • Comment → User: Many-to-One (um comentário pertence a um usuário)
  • Comment → Post: Many-to-One (um comentário pertence a um post)

🚀 Deploy

🌐 Vercel (Recomendado)

  1. Configure o banco de dados:

    • Use um serviço como Supabase, Railway ou Neon
    • Configure as variáveis de ambiente

  2. Deploy automático:

    • Conecte o repositório ao Vercel
    • Configure as variáveis de ambiente
    • Deploy automático a cada push

🤝 Contribuindo

Este é um projeto de estudo, mas sugestões e melhorias são bem-vindas!

📝 Como Contribuir

  1. Fork o projeto
  2. Crie uma branch para sua feature (git checkout -b feature/AmazingFeature)
  3. Commit suas mudanças (git commit -m 'Add some AmazingFeature')
  4. Push para a branch (git push origin feature/AmazingFeature)
  5. Abra um Pull Request

📞 Contato

Gabriel - Desenvolvedor Frontend Junior

📄 Licença

Este projeto é para fins de estudo e aprendizado. Sinta-se livre para usar como referência para seus próprios projetos!

🚀 Desenvolvido com ❤️ para aprendizado de React Native

"A melhor forma de aprender é fazendo!"

About

Uma api simples que utilizei para um projeto em React Native, ela usa Nest JS e postgreSQL, O ORM utilizado foi o typeORM.

api-forum-simples.vercel.app

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages