Git Product home page Git Product logo

inventory-backend's Introduction

inventory-backend

Installation

Requirements:

Docker must be installed on your machine

  • Clone the repo locally

    git clone [email protected]:Omar-kh/inventory-backend.git
  • Go into the folder

    cd inventory-backend
  • Build the docker container (may take some time, make sure you have an Internet connection):

    sudo docker build -t inventory-backend .
  • Run the container

    sudo docker run -d -p 5000:5000 inventory-backend

That's it. Your API should be running on your machine on port 5000

API Endpoints

The API has two endpoints :

Supposing your are on localhost:

All products

http://localhost:5000/inventory

==> Returns a list of products with their ids and names

[

    {
        "product_id": "9f0d518206",
        "product_name": "Product_1"
    },
    {
        "product_id": "6fd7aaa08a",
        "product_name": "Product_2"
    },
    
    ...

]

A product info

http://localhost:5000/inventory/${product_id}

==> Returns inventory values of the requested product over time

{

    "product_id": "9f0d518206",
    "product_name": "Product_1",
    "dates": [
        "2019-07-01",
        "2019-07-02",
        "2019-07-03",
        "2019-07-04",
        "2019-07-05",
        ...
    ],
    "values": [
        9641,
        181,
        908,
        6536,
        2983,
        ...
    ]

}

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.