Point of Sales API

RESTful API for Point of Sales App

Table of contents

• Point of Sales API
  • Table of contents
  • TODO Tasks
  • Stacks
  • Build Setup
  • API Docs
    • Products
    • Category
    • User
    • Auth

TODO Tasks

• CRUD Products
• CRUD Categories
• Unique name (on categories and product) and email (on users)
• Add/Reduce Products (Quantity)
• Validation schema
• Search product by name
• Sort product by name, category, date updated
• Pagination products
• Upload image (on products)
• Cannot reduce stock (on products) below 0
• Allowed CORS
• Authentication with JWT
• Rows caching with redis

Stacks

• NodeJS
• MySQL
• ExpressJS
• Sequelize ORM
• JWT
• Joi Validator
• Redis

Build Setup

1. Clone repository $ git clone https://github.com/sutanlab/point-of-sales-api.git

2. Install depedencies

# with npm
$ npm install

# or with yarn
$ yarn install

3. Setup your environment variable in .env files (if not exists, create your own).

# NODE_ENV development | production | test
NODE_ENV = development

# DATABASE
DB_HOSTNAME = 127.0.0.1
DB_USERNAME = root
DB_PASSWORD = xxxx
DB_NAME = dbtest

# SECRET KEY
SECRET_JWT = xxxx

4. Run database migrations (with shortcut scripts with yarn or npm run)

$ yarn db:init # create database

$ yarn db:migrate # run database migrations

$ yarn db:seed # run database seeder (if you want)

$ yarn db:rollback # rollback migrations

$ yarn db:drop # drop table

5. Start API server

$ yarn watch # start and watch server

$ yarn start # start server

API Docs

Products

Category

User

Auth

Copyright © 2019 by Sutan Gading Fadhillah Nasution