Cafe Service

About the project

This API service is facilitate to maintain the cafe's and Employees records.

Main features included :

• Create New cafe
• Register new employee and asign to the cafe
• List cafe`s
• List Employees
• Edit Cafe
• Edit Employee
• Filter Cafe by location
• List Employees by Cafe

Getting started

Follow bellow steps on CLI before getting start

1. Run git clone [email protected]:YasiruDev/cafe-service.git for clone project
2. Run cd cafe-service
3. Run npm install for install packages

Run Application

Follow bellow script on CLI to run this Application

1. Run npm start or npm run dev

Requirements

• NodeJs - V12
• MySQL -V8.0.29

.env configurations

APP_PORT=3002 LOG_MODE=true

#db DB_HOST=xxxxx DB_USER=xxx DB_PASSWORD=xxx DB_DATABASE=xxx

DB schema

Find the DB schema under below folder path cafe-service -> src -> migrations

Documents

• API Document
• Postman Collection