RESTful API Computer Inventory App

---

Table of contents

• Prerequiste
• Installation
• Documentation
• License

Prerequiste

• Node.js - Download and Install Node.js with NVM (Node Version Manager) - Simple bash script to manage multiple active node.js versions.
• MySQL - Download and Install MySQL - is a free and open-source cross-platform web server solution stack package developed by Apache Friends, consisting mainly of the Apache HTTP Server, MariaDB database, and interpreters for scripts written in the PHP and Perl programming languages. Since most actual web server deployments use the same components as XAMPP, it makes transitioning from a local test server to a live server possible.
• Postman - Download and Install Postman - Implementation with postman latest version.

Tools

• Visual Code Studios VSCode

Installation

Clone

$ git clone https://github.com/allandallopez/My-Inventory-App.git
$ cd My-Inventory-App
$ npm install

Import Database Design

Import myinventory.sql into your database.

Create Environment Variable

Create new file .env on your favorite code editor, and copy paste this code below :

IP = "YOUR IP ADDRES"
SERVER_PORT ="YOUR SERVER PORT"

DB_HOST = "YOUR DB HOST"
DB_USER = "YOUR DB USER"
DB_PASSWORD = "YOUR DB PASSWORD"
DB_NAME = "YOUR DB NAME'

JWT_KEY= "A SCRETKEY FOR JWT"
JWT_EXP= "JWT EXPIRATION" 

Start Development Server

$ npm start

Documentation

USER Routes

POST Request

 1. "/register" => Create user and return token. 
    a. Required Body: 
       1) username: string
       2) email: string
       3) password: string

 2. "/login" => Log In user and return token. 
    a. Required Body:
       1) email: string
       2) password: string

PRODUCT Routes

GET Request

 1. "/products" => Display products, with default pagination {page: 1, limit: 3}. 
    a. Options Query:
       1) search -> {input: search keywords}, search products that have {input} in their title.
       2) sortby -> {input: column name}, sort products based on {input} with default {id}.
       3) sort   -> {input: asc / desc}, sort products ascending or descending based on {input}.
       4) page	 -> {input: number}, display page based on {input}.
       5) limit  -> {input: number}, config how many product displayed on page.

 2. "/products/:id" => Display product with {id}.

POST Request

 1. "/products" => Create product and return inserted data.
    a. Required Header: { authorization : Dello 'token' }
    b. Required Body: 
       1) name: string
       2) description: string
       3) image: string //image url
       4) id_category: number
       5) quantity: number

PUT Request

 1. "/products/:id" => Update product with {id} and return inserted data.
    a. Required Header: { authorization: token : Dello 'token' }
    b. Required Body: 
       1) name: string
       2) description: string
       3) image: string //image url
       4) id_category: number
       5) quantity: number

PATCH Request

 1. "/products/quantity/" => Add or reduce product quantity with {id}.
    a. Required Header : { authorization: token : Dello 'token' }
    b. Required Body:
       1) act: add/reduce
       2) id: number
       3) value: number

DELETE Request

 1. "/products/:id" => Delete product with {id}.
    a. Required Header : { authorization: Dello 'token' }

CATEGORY Routes

GET Request

 1. "'/category" => Display categories. 

 2. "/category/:id" => Display category with {id}.

POST Request

 1. "/category" => Create category and return inserted data.
    a. Required Header: { auth: token, username: username, email: email }
    b. Required Body: { name: string }

PUT Request

 1. "/api/category/{id}" => Update category with {id} and return inserted data.
    a. Required Header: { authorization: Dello 'token' }
    b. Required Body: { name: string }

DELETE Request

 1. "/category/:id" => Delete category with {id}.
    a. Required Header: { authorization: Dello 'token' }

License

---

ISC