Giters

kasunsampath / pos-api

Point of Sale API (NodeJS + ExpressJS + MySQL)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Point of Sale API

This project created for learning purpose of how to make an API using nodejs and express.js. Feel free to use this project for reference. or not.

Getting Started

Requirements

  • Node.js (tested on v14.15.3)
  • NPM (tested on v6.14.9)
  • Yarn (tested on v1.22.5)
  • MySQL 5 (tested on v5.7.37)

Clone Project

Clone and install dependencies

> git clone https://github.com/reyusfa/pos-api.git
> cd pos-api
> yarn install

Setting Server & Database

  1. Install MySQL.
  2. Create new database.
  3. Import file point_of_sale.sql to your database.
  4. Edit file .env to configure Server & MySQL connection.
SERVER_PORT=3001
SERVER_HOST=127.0.0.1
DB_HOST=127.0.0.1
DB_NAME=point_of_sale
DB_USERNAME=root
DB_PASSWORD=
PUBLIC_IMAGES=http://localhost:3001
SECRET_KEY=SECRET_KEY

Start Server

> yarn start
now listening on http://127.0.0.1:3001
now connected to database...

Folder Structures

├── index.js
├── node_modules
├── package.json
├── point_of_sale.sql
├── public
│   └── images
├── README.md
└── src
    ├── config
    │   └── mysql.js
    ├── controller
    │   ├── categories.js
    │   ├── orders.js
    │   └── products.js
    ├── helper
    │   └── index.js
    ├── middleware
    │   └── files.js
    ├── models
    │   ├── categories.js
    │   ├── orders.js
    │   └── products.js
    └── routes
        ├── categories.js
        ├── index.js
        ├── orders.js
        └── products.js

API Documentation

Login & Register

Login user

POST /login

Request Header:
Content-Type: application/json [OR] application/x-www-form-urlencoded
Authorization: TOKEN
Request Body:
{
  "username": "admin",
  "password": "admin"
}
Response:
{
  "status": 200,
  "data": {
    "token": "TOKEN",
    "id": 1,
    "role_id": 1,
    "name": "Admin"
  }
}

Register user

POST /register

Request Header:
Content-Type: multipart/form-data
Authorization: TOKEN
Request Body:
{
    "username": "badmin",
    "password": "badmin",
    "email": "badmin@email.com",
    "name": "Badmin",
    "image": "", //optional
    "role_id": 1
}
Response:
{
  "status": 200,
  "data": {
    "id": 23,
    "username": "badmin",
    "email": "badmin@email.com",
    "name": "Badmin",
    "image": "",
    "role_id": 1
  }
}

Products

Endpoint list

  • GET /products
  • GET /products/:id
  • POST /products
  • PUT /products/:id
  • DELETE /products/:id

Show all products

GET /products

Response:
{
  "code": 200,
  "data": [
    {
      "id": 1,
      "name": "Juice",
      "price": 2000,
      "category_id": 1,
      "description": "Fresh Juice",
      "image": "public/images/image-1579661507990.jpeg",
      "created_at": "2020-01-22T02:51:48.000Z",
      "updated_at": "2020-01-22T02:51:48.000Z"
    },
    {
      "id": 2,
      "name": "Tea",
      "price": 2000,
      "category_id": 1,
      "description": "Fresh Tea",
      "image": "public/images/image-1579661516758.jpeg",
      "created_at": "2020-01-22T02:51:56.000Z",
      "updated_at": "2020-01-22T02:51:56.000Z"
    }
  ]
}

Sorting, Filtering, & Pagination

Supported query parameters:

  • ?sort=name.desc
  • ?filter[name]=
  • ?limit=80
  • ?limit=10&page=2
  • ?limit=10&offset=30

Show product by id

GET /products/:id

Response:
{
  "code": 200,
  "data": {
    "id": 1,
    "name": "Juice",
    "price": 2000,
    "category_id": 1,
    "description": "Fresh Juice",
    "image": "public/images/image-1579661507990.jpeg",
    "created_at": "2020-01-22T02:51:48.000Z",
    "updated_at": "2020-01-22T02:51:48.000Z"
  }
}

Add product

POST /products

Request Header:
Content-Type: multipart/form-data
Authorization: TOKEN
Request Body:
{
  "name": "Orange Juice",
  "price": 3000,
  "category_id": 1,
  "image": "", //optional
  "description": "Fresh Orange Juice"
}

Update product by id

PUT /products/:id

Request Header:
Content-Type: multipart/form-data
Authorization: TOKEN
Request Body:
{
  "price": 3000,
}

Delete product by id

DELETE /products/:id

Request Header:
Content-Type: application/json [OR] application/x-www-form-urlencoded
Authorization: TOKEN

Categories

Endpoint list:

  • GET /categories
  • GET /categories/:id
  • POST /categories
  • PUT /categories/:id
  • DELETE /categories/:id

Show all categories

GET /categories

Response:
{
  "code": 200,
  "data": [
    {
      "id": 1,
      "name": "Drink",
      "created_at": "2020-01-22T02:51:48.000Z",
      "updated_at": "2020-01-22T02:51:48.000Z"
    },
    {
      "id": 2,
      "name": "Meal",
      "created_at": "2020-01-22T02:51:56.000Z",
      "updated_at": "2020-01-22T02:51:56.000Z"
    }
  ]
}

Show category by id

GET /categories/:id

Response:
{
  "code": 200,
  "data": {
    "id": 1,
    "name": "Drink",
    "created_at": "2020-01-22T02:51:48.000Z",
    "updated_at": "2020-01-22T02:51:48.000Z"
  }
}

Add category

POST /categories

Request Header:
Content-Type: application/json [OR] application/x-www-form-urlencoded
Authorization: TOKEN
Request Body:
{
  "name": "Snack"
}

Edit category by id

PUT /categories/:id

Request Header:
Content-Type: application/json [OR] application/x-www-form-urlencoded
Authorization: TOKEN
Request Body:
{
  "name": "Coklat"
}

Delete category by id

DELETE /categories/:id

Request Header:
Content-Type: application/json [OR] application/x-www-form-urlencoded
Authorization: TOKEN

Orders

Endpoint list:

  • GET /orders
  • GET /orders/:id
  • GET /orders/:id/items
  • GET /orders/:id/items/:id_item
  • POST /orders
  • DELETE /orders/:id

Show all orders

GET /orders

Response:
{
  "code": 200,
  "data": [
    {
      "id": 1,
      "reference": "67478591",
      "user_id": 1,
      "total": 50000,
      "created_at": "2020-01-22T13:51:33.000Z",
      "updated_at": "2020-01-22T13:51:33.000Z"
    },
    {
      "id": 1,
      "reference": "34751923",
      "user_id": 1,
      "total": 20000,
      "created_at": "2020-01-22T13:51:33.000Z",
      "updated_at": "2020-01-22T13:51:33.000Z"
    }
  ]
}

Show order by id

GET /orders/:id

Response:
{
  "code": 200,
  "data": {
    "id": 1,
    "reference": "67478591",
    "user_id":  1,
    "total":  50000,
    "created_at": "2020-01-22T02:51:48.000Z",
    "updated_at": "2020-01-22T02:51:48.000Z"
  }
}

Show items of order by id

GET /orders/:id/items

Show items detail of order

GET /orders/:id/items/:id_item

Add order

POST /orders

Request Header:
Content-Type: application/json [OR] application/x-www-form-urlencoded
Authorization: TOKEN
Request Body:
{
  "user_id": 1,
  "orders": [
    {
      "product_id": 1,
      "quantity": 1
    },
    {
      "product_id": 2,
      "quantity": 2
    }
  ]
}

Delete order by id

DELETE /orders/:id

Request Header:
Content-Type: application/json [OR] application/x-www-form-urlencoded
Authorization: TOKEN

Users

Show all users

GET /users

Show user by id

GET /users/:id

Update user by id

PUT /users/:id

Delete user by id

DELETE /users/:id

About

Point of Sale API (NodeJS + ExpressJS + MySQL)

Languages

Language:JavaScript 99.7%Language:Shell 0.3%