faelkk / mycontacts-api

A API My-Contacts é um projeto desenvolvido para ser utilizado pelo My Contacts FE. Seu objetivo é proporcionar um gerenciamento aprimorado de contatos, permitindo que o usuário realize operações como cadastro, edição, remoção e visualização de seus contatos e categorias.

My-Contacts API

Esse projeto foi desenvolvido durante curso JStack, com o objetivo de oferecer um eficiente gerenciamento de contatos. Com esta aplicação, os usuários podem cadastrar, editar e excluir contatos e categorias de forma simples e intuitiva. Além disso, integra-se perfeitamente à aplicação de gerenciamento de contatos My-contacts fe, proporcionando uma experiência aprimorada para o usuário no controle de seus contatos. Simplifique a administração dos seus contatos com esta aplicação sólida.

Documentação

A documentação dessa API é feita automaticamente pela lib Swagger, proporcionando facilidade na compreensão e utilização da API. Isso ajuda em uma integração simples e intuitiva para os devs.

Sinta à vontade para explorar a documentação e tirar proveito dos recursos disponibilizados por esta API para impulsionar seus projetos financeiros. Me dediquei ao maximo para conseguir oferecer uma boa experiência para os usuarios dessa api, e tambem para auxiliar os devs que buscam ajuda na documentação.

Caso necessite algum ajuste ou informação adicional, não hesite em entrar em contato comigo. Estou à disposição para ajudar no que for necessário!

Doc Swagger

🛠️ Tecnologias

📁 Back-end

• Nest.js: Optei por usar o Nest.js como framework para o back-end devido à sua arquitetura de modulos e baseada em conceitos sólidos. A estrutura orientada a módulos e a integração com TypeScript possibilitam uma estrutura sólida para o desenvolvimento, facilitando a manutenção e escalabilidade do código.

• MongoDB: Escolhi MongoDB para o banco de dados por conta do seu modelo de dados flexivel, e por conta de sua facilidade com integração em diferentes linguagens de progamação.

• Mongoose: O mongoose foi escolhido para fazer a conexão com o banco de dados e sua facilidade em fazer isso.

• Prisma: Utilizei o prisma como ORM, que facilita muito a interação com o banco de dados fazendo tarefas como criar e atualizar coisas no banco serem muito mais simples de serem realizadas.

🔋 Controle de versão e deploy

• Git Utilizei Git para controle de versionamento, o que facilita o trabalho colaborativo e o acompanhamento das alterações no código.

• Vercel A escolha da Vercel para deploy foi feita devido à sua integração fácil com repositórios Git e sua eficiência no deployment de aplicações.

⚙️ Configuranções e Instalações

Clone do Projeto

$ git clone https://github.com/Faelkk/mycontacts-api

Instalando as dependências

$ npm install

Iniciando o projeto

$ npm run dev

Como me ajudar nesse projeto?

• Você ira me ajudar muito me seguindo aqui no GitHub
• Dando uma estrela no projeto
• Conectando-se comigo no LinkedIn para fazer parte da minha rede.

Feito por Rafael Achtenberg