MyContacts

Uma API Node.js para criar e categorizar contatos, com Express e Postgres(Docker). Desenvolvido como projeto de estudo na Formação Fullstack, da plataforma JStack. O desafio proposto neste projeto foi desenvolver o CRUD das categorias.

🛠️ Tecnologias

Ferramentas usadas na construção do projeto:

• Node.js (v22.12.0)
• npm (v10.9.2)
• Express (v4.22.1)
• Docker (v29.4.2)
• Docker Desktop (v4.73.1)
• YAML (v2.9.0)
• Swagger-ui-express (v5.0.1)

Ferramentas usadas no desenvolvimento do projeto:

• VSCode (v1.119.1)
• Insomnia(v10.3.0)
• Yarn (v1.22.22)
• Nodemon (v3.1.14)
• ESLint (v9.29.0)
• EditorConfig

💻 Funcionalidades e Demonstração da Aplicação

Controllers:

• index(): método para listar registros existentes

• show(): método para buscar registro por parâmetros(IDs, email, nome)

• store(): método para criar novo registro

• update(): método para atualizar um registro

• delete(): método para apagar um registro

Repositories:

• findAll(): Lista todos os contatos/categorias cadastrados

• findById(): Retorna um contato/categoria com ID correspondente

• findByEmail(): Retorna um contato com email correspondente

• findByName(): Retorna uma categoria com nome correspondente

• create(): Cria um novo contato/categoria

• update(): Atualiza dados de um contato/categoria existente

• delete(): Deleta contato/categoria com ID correspondente

📂 Acesso ao Projeto

#Baixar arquivos manualmente ou clonar repositório
$ git clone [url_projeto]

⚙️ Executar

# Instalar o Docker, baixar img do Postgres, criar container e deixar executando
# Estruturar banco de dados conforme schema.sql
# Abrir projeto e executar aplicação no terminal do VSCode
$ yarn install
$ yarn dev

No Postman/Insomina testar as rotas GET, POST, PUT e DELETE com a seguintes URLs:

• http://localhost:3000/contacts
• http://localhost:3000/categories

Para testar com Swagger, acessar a documentação:

• http://localhost:3000/api-docs

Pessoas Desenvolvedoras do Projeto

Stephanie de França

Licenses