Giter Club home page Giter Club logo

auto-shop's Introduction

Auto Shop ๐ŸŽ๏ธ

Project Context ๐Ÿ’ก

API that manages a vehicle concessionaire using the four basic CRUD operations. I designed the project architecture with a layered approach based on Domain-Driven Design (DDD), incorporating Object-Oriented Programming (OOP) and SOLID principles. To ensure correctness, I developed unit and integration tests to cover almost 99% of the project's functionalities.

Acquired Knowledge ๐Ÿ“–

In this project, I was able to:

  • Create an API CRUD using OOP and SOLID principles;
  • Use MongoDB;
  • Use Mongoose ODM;
  • Create unit tests;
  • Create Integration tests.

Main Technologies ๐Ÿงฐ

Development

TypeScript Express Mongoose Node.JS MongoDB Docker Insomnia
typescript express mongoose nodejs mongodb docker insomnia

Test

Mocha Chai Sinon
mocha-js chai-js sinon-js

Running the application โš™๏ธ

  1. Clone the repository and enter it
git clone [email protected]:ImVictorM/Auto-Shop.git && cd Auto-Shop

Methods

๐Ÿ‹ Running with docker (recommended)

You must have docker and docker-compose installed

  1. Get the containers running
docker-compose up -d

๐Ÿ–ฅ๏ธ Running locally

You must have node on version 16 and MongoDB installed

  1. Install the dependencies
npm install
  1. Rename the file .env.example to .env

  2. Start the server

npm run dev

Testing ๐Ÿ› ๏ธ

Note: if you're running the app using docker, you must use the following commands inside the car_shop container. To enter the container, type:

docker exec -it car_shop bash

Running all tests:

npm test

Running integration tests:

npm run test:integration

Running unit tests:

npm run test:unit

Run all tests and see its coverage:

npm run test:coverage

Endpoints ๐ŸŒ

Click here to export automatically:

Run in Insomnia}

Or just import the file insomniaRoutes.json inside your environment: https://docs.insomnia.rest/insomnia/import-export-data

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.