/Cashier-POS-System

A simple cashier POS system

Primary LanguageJavaScript

Contributors Forks Stargazers Issues MIT License


Cashier POS System

Explore the docs »

View Demo

Table of Contents
  1. About The Project
  2. Getting Started
  3. License
  4. Contact

About The Project

Product Name Screen Shot

A simple web application that simulate the cashier point of sale system.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

ReactJS, Tailwind CSS, Express, Prisma

  • NodeJS
  • Any code editor e.g. VSC, Atom

Installation

  1. Clone the repo

    git clone https://github.com/KhairulAminShabudin/Cashier-POS-System
  2. Download and Install the latest version of PostgreSQL

  3. Install all dependencies by running the code below in your VS Code terminal

    npm run install-all
  4. Create .env file in root folder and store the following informations

      PORT=YOUR DESIRED RUN PORT
     
    DATABASE_URL="postgresql://YOUR_USERNAME:YOUR_PASSWORD@localhost:5432/DATABASE_NAME?schema=SCHEMA_NAME"
  5. Setup for Prisma

    1. Run the following command in your VS Code terminal
    npx prisma migrate dev --name init
    1. [Optional] Open Prisma Studio by running the following in the terminal
    npx prisma studio
  6. Start the backend server

    1. Run the following in VS Code terminal
    npm start
  7. Launch web application

    1. Go to the client directory in by running the following command in the terminal:
    cd client
    1. Launch web server
    npm start

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Khairul Amin Shabudin - khairulaminshabudin@gmail.com

Project Link: Cashier POS System

(back to top)