This project is a simple implementation of an e-commerce app.

You need to have the following installed on your local development system before you can go ahead with this project (except you want to develop using docker).

• Nodejs at least 10.16.0 or later version
• MSSQL

npm install

For developmental purpose, run the following commands

npm run start:dev

To run test, run below command

npm run test

For production, run below command

npm run start

For docker, run the following commands

docker-compose up -d

This project is structured in modules. We have the Categories module, Products module and Suppliers module

The Categories module contains information about a product category. The files in this module include category controller, entity, provider, validations and the unit tests.

The Products module contain information about products. The files are also structured exactly the same.

The Suppliers module contain information about suppliers. The files are also structured exactly the same.

The features of this project include the following.

• Create a new product
• Update a product
• Get all products paginated
• Get a product with its supplier and category
• Search a product
• Create a category
• Get a category with its associated products
• Get a supplier
• Get a supplier with associated products
• Delete a supplier

The API documentation for testing the endpoints is located here

While the project documentation can be found here

ISC