/megaventory-task

This small project is made for completing a task to join Megaventory company internship program.

Primary LanguageHTMLMIT LicenseMIT

megaventory-task

Megaventory

Table of Contents

Description

This small project is made for completing a task to join Megaventory company internship program.

Megaventory company is a cloud-based order and inventory management solution aimed at medium-sized businesses.

Built With

Getting Started

This is a list of needed instructions to set up your project locally, to get a local copy up and running follow these instructions.

  1. Clone the repository.

  2. cd into megaventory-task folder, create a file named .env and fill it with fields in example.env with your information.

  3. Follow this article to install node js and npm Install Node js and npm

    .

  4. npm i && npm start

  5. run unit tests with this command: npm run test

Relation with older project

There is a relation between this project and an older project called RedditX, that I nearly followed the same project architecture (Controller => Service => Entity or Model),
that is, Service is responsible for handling dealing with database or with requesting external service,
and Controller is reponsible for handling requests and providing data for services,
and Entity or Model is responsible for representing the business logic,
and finally if there is need for something like emails, then View is reposnsible for building this email's view for example.

Swagger API Documentation

You can look on the Swagger API documentation at API Documentation

Postman Collection

You can look on this Postman Collection in order to try any request at Postman Collection

Function Documentation

You can look on this Function Documentation at this file ./function-documentation/index.html