Order System v0.01

Order System for local shop(Still Devloping)

---

Quick Start For Development

For Backend Developers

# clone repo
git clone https://github.com/p0937507934/order_system.git

# install dependency
cd order_system
yarn install 
cd server
yarn install

For Frontend Developers

# clone repo
git clone https://github.com/p0937507934/order_system.git

# install dependency
cd order_system
yarn install 
cd admin
yarn install

Usage

Backend Server

# change directory to server
1. cd order_system/server

# run server using docker-compose on localhost:8000
2. docker-compose up -d

# try api healthcheck
3. http://localhost:8000/api/healthcheck

# migrate db
4. npm run migrate

Frontend Server

# change directory to server
1. cd order_system/admin

# run server using docker-compose on localhost:3003
2. docker-compose up -d

# try api healthcheck
3. http://localhost:3003

Developer Workflow

Local Development

• Clone: Click here
• New Branch: Create a new branch for your features.

# this command will create a new branch and checkout to it.

git checkout -B branch_name

• Testing: Push origin dev branch and test your function.
• Pull Request: Make a pull request and notify your partner for code review on slack or mention on github.

Pull Request Title

Format: <Type>: <Description>, where `Description starts with verb is preferred.

project: Add a new  API for x functionality
^--^     ^------------^
|        |
|        +-> Summary your works.
|
+-------> Type:Admin,Backend,App,DB,...etc

DB Design

Git Process