Giter VIP home page Giter VIP logo

cafe-backend's Introduction

Online Cafe Backend API

This is the backend application of the Cafe store app. I have add few steps to compile and run the application locally and using Docker.

Technologies

  • Node JS
  • Express
  • TypeScript
  • MySQL
  • Sequelize
  • AWS RDS
  • AWS S3

Before start, please check the Node and NPM versions. I have added my versions below

  • Node JS - 18.13.0
  • NPM - 8.19.3

Run the application locally

  1. Clone the GitHub repository to your computer using this link
  2. Once cloned, run the following command to install the dependencies
npm install
  1. After all the dependencies are installed, run the following command to start the application on Dev mode
npm run start:dev
  1. Finally, the application will run on port 8088. Access the application via this link. If the port number is already used in your machine, change the port number to a different one.

Run the application using Docker

  1. Make sure Docker is installed to your computer
  2. Clone the GitHub repository to your computer using this link
  3. Run the following command to build the Docker image
docker build -t cafe-backend-app:v1.0.0 .
  1. Once the Docker image is built, run the following command to start the aplication via Docker container
docker run --name cafe-backend -p 8088:8088 cafe-backend-app:v1.0.0
  1. Finally, the application will run on port 3000. Access the application via this link

cafe-backend's People

Contributors

rusiruavb avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.