Git Product home page Git Product logo

inventorify's Introduction

๐Ÿฌ Inventorify - Shopify Intern Technical Challenge

My submission for the Shopify Production Engineer and Backend Developer technical challenges.

Getting Started

There are two options to build and run the program locally. Via npm or via docker.

Building and Running the Program Locally

A local installation of MongoDB is required for building and running the program. A free community version can be found here: https://www.mongodb.com/try/download/community.

From the root of the project, run:

sudo mongod
npm install
npm run dev

The program will run on http://localhost:3000.

Building and Running the Program Locally with Docker

From the root of the project, run:

docker-compose up

The program will run on http://localhost:4000.

Testing

To run tests:

npm install
npm run test

API Documentation

The application is a simple CRUD API for managing vendors and their inventory. The routes are documented below.

Routes - /api/product

All /api/product routes can be found in the product.router.js module within the source code.

GET /api/product

Retrieves a list of all inventory items.

GET /api/product/:vendorName

Retrieves a list of all inventory items of a specific vendor.

POST /api/product/:vendorName/:productName

Creates a new inventory item for a specific vendor.

GET /api/product/:vendorName/:productName

Retrieves a specific inventory item.

PUT /api/product/:vendorName/:productName

Updates a specific inventory item.

DELETE /api/product/:vendorName/:productName

Deletes a specific inventory item.

Routes - /api/vendor

All /api/vendor routes can be found in the vendor.router.js module within the source code.

GET /api/vendor

Retrieves a list of all vendors.

POST /api/vendor

Creates a new vendor.

GET /api/vendor/:vendorName

Retrieves a specific vendor.

PUT /api/vendor/:vendorName

Updates a specific vendor.

DELETE /api/vendor/:vendorName

Deletes a specific vendor.

inventorify's People

Contributors

eysk-io avatar

Watchers

 avatar

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.