Skip to content

StuartDambi/coffee-machine

Repository files navigation

COFFEE MACHINE Build Status

This is an inventory management Platform for a coffee retail Shop. It is built with Nodejs, Sequelize and Postgres as a database.

Pre-Requisites

  • Postgresql and database created

How to Install and run the application

  • Clone the application and run yarn
  • Run cp .env.example .env to create .env variables and fill them
  • Run yarn dev to create db migrations and run server

API Documentation

End Point Name Method Category EndPoint Description
Register User POST Users /api/v1/users/auth/signup This registers a users to the system
Login User POST Users /api/v1/users/auth/login This handles login of a users to the system

Technologies Used

  • NodeJs / Express
  • Postresql Database with Sequelize as ORM
  • Redis
  • Swagger for API Documentation
  • Heroku For Hosting

About

A Nodejs Sequelize coffee retail shop inventory management system

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published