clean-node-api: Rest API in NodeJS using Test Driven Development (TDD), Clean Architecture and Design Patterns ✅

Technologies   |    Project   |    Getting started   |    How to contribute   |    License

🚀 Technologies

This project was developed with the following technologies:

• Node.js

Extras:

• Style
  • EditorConfig
  • ESLint
  • Standard
• Testing
  • Jest

💻 Project

Project using Test Driven Development, Clean Architecture and Design Patterns.

💺 Getting started

These instructions will get you a copy of the full project up and running on your local machine for development and testing purposes.

Setting up the development environment

The project is developed using Git, Node.js and npm:

• Git is a free and open source distributed version control system. Download Git.
• Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. Download Node.js.
• npm is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer.

Cloning the project

You can obtain the project by running the instruction bellow on your terminal:

git clone https://github.com/diegomais/clean-node-api.git

Installing dependencies and running tests

Run the instructions bellow inside clean-node-api directory:

npm install
npm test

🤔 How to contribute

• Fork this repository
• Create a branch with your feature: git checkout -b my-feature
• Commit your changes: git commit -m '[feat](scope) my new feature'
• Push to your branch: git push origin my-feature

After the merge of your pull request is done, you can delete your branch.

📝 License

This project is under the MIT license. See the LICENSE for more details.

---

Made with ❤️ by Diego Mais 👋.