SE.Kopi Backend

Welcome to SE.Kopi Backend API! This project serves as the backend for SE.Kopi web application.

Table of Contents

• Technologies Used
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • API Endpoints
• Demo API

Technologies Used

Technologies	Annotation
JavaScript	Programming language used for both frontend and backend development.
Express.Js	Web application framework for Node.js.
Node.Js	JavaScript runtime for server-side development.
PostgreSQL	Open-source relational database management system.
Postman	API development and testing tool.
Visual Studio Code	Code editor for efficient development.
GitHub	Hosting our version-controlled code repository.
Vercel	Platform for hosting and deploying web applications.

Getting Started

To set up the project locally, follow these steps:

Prerequisites

Before you begin, make sure you have the following tools and software installed:

• Node.js: Ensure that Node.js is installed on your machine. You can download it from the official website.

• PostgreSQL: Install PostgreSQL, an open-source relational database management system. Follow the installation instructions on the official PostgreSQL website.

• Postman: Download and install Postman, an API development and testing tool. You can find the download link on the Postman website.

• Visual Studio Code: If you prefer using VSCode as your code editor, download and install it from the official website.

• GitHub Account: Create a GitHub account if you don't have one. You will use GitHub for version control and collaboration.

• Vercel Account: Create a Vercel account. Vercel is a cloud platform for hosting and deploying web applications. You will use it to deploy your projects. Sign up on the Vercel website.

Installation

1. Clone the repository:

   git clone https://github.com/Kampus-Merdeka-Software-Engineering/BE-2-Bandung-24

   Change to the repository directory:

   cd BE-2-Bandung-24

2. Install dependencies:

   npm i

Usage

To run the backend server:

npm start

The API will be accessible at http://localhost:3001

API Endpoints

• GET /v1: Retrieve API.
• GET /v1/menu: Retrieve all menu.
• GET /v1/menu/category: Retrieve menu by category.
• GET /v1/transaction: Retrieve all transaction.

Demo API

Check out our live demo at:

• 🚀 https://api.sekopi.biz.id/v1
• 🚀 https://api.sekopi.biz.id/v1/menu
• 🚀 https://api.sekopi.biz.id/v1/menu/coffee
• 🚀 https://api.sekopi.biz.id/v1/menu/juice
• 🚀 https://api.sekopi.biz.id/v1/menu/croissant
• 🚀 https://api.sekopi.biz.id/v1/transaction