This repository contains a simple Node.js API for managing car models. The architecture has been designed following the SOLID principles to ensure maintainability and scalability.
- Built with Express.js.
- Uses MongoDB as a data store.
- Designed around the SOLID Principles for improved maintainability and scalability.
- Support for Docker Compose to quickly start up necessary services.
-
Clone the repository:
git clone https://github.com/vascoII/node_api.git
-
Install the required dependencies:
npm install
-
Start the server:
npm start
You can interact with the API using the following endpoints:
- GET
/cars: Retrieves all cars. - GET
/cars/:name: Retrieves a specific car by its name. - POST
/cars: Creates a new car. - PUT
/cars/:name: Updates a car by its name. - PATCH
/cars/:name: Partially updates a car by its name.
This application includes a suite of unit tests to ensure its functionality and reliability. We use the mocha testing framework in conjunction with chai for assertions and sinon for mocking. Running the Tests
Ensure you have all the required dependencies installed:
npm install
To run the test suite, execute the following command:
npm test
The tests cover the following aspects of the application:
Car Service:
Retrieving all cars
Retrieving a car by its name
Creating a new car
Error handling when attempting to create a car that already exists
Updating a car by its name
We encourage contributions to the application. If you're adding new functionality or making changes, please ensure that you also write the necessary tests to cover your changes. This helps maintain the reliability of the application.
If you wish to contribute, kindly follow these steps:
- Fork this repository.
- Clone your fork to your local environment.
- Make and commit your changes.
- Push your commits back to your fork on GitHub.
- Submit a pull request from your forked repo to this repo.
This software is released under the MIT License. For more details, please refer to the LICENSE file.
