/Clean-Node-API

Node.js API using CLEAN Architecture, Typescript and TDD

Primary LanguageTypeScriptMIT LicenseMIT

CLEAN Architecture

GitHub language count Repository size GitHub last commit License Stargazers
Linkedin - Pedro Henrique Email - Pedro Henrique Fale comigo no whatsapp - Pedro Henrique

💻 Sobre o projeto

©️ API desenvolvida em Node.js seguindo a arquitetura CLEAN com as seguintes funcionalidades:

  • [👥 Login]
  • [🗂️ Cadastro]
  • [📈 Criação de enquetes]
  • [📝 Lista de enquetes]
  • [🗣️ Responder enquete]
  • [✔️ Resultado da enquete]

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

  • [Mongo.db]
  • [Git]
  • [Jest]
  • [CI/CD]
  • [Swagger]
  • [Node.js]
  • [TypeScript]

🚀 Como executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, [Node.js][nodejs]. Além disto é bom ter um editor para trabalhar com o código como [VSCode][vscode]

🎲 Rodando o Back End (servidor)

😯 Como contribuir para o projeto

  1. Faça um fork do projeto.
  2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
  3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
  4. Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Pedro Henrique 👋🏽 Entre em contato!