• Overview
• Tech Stack
• Features
• Getting Started
  • Prerequisites
  • Instalation & Environments
• Postman Documentation
• Table Structure
• Related Projects
• Contributors
• License
• Report

klontong. REST API is a backend server implementation designed for a online shop using the Express framework. It provides a robust and scalable solution for managing various aspects of a coffee shop's operations, such as products and categories.

The REST API follows the principles of Representational State Transfer (REST), which enables easy integration with various clients, including web and mobile applications. It utilizes the HTTP protocol for communication, allowing clients to perform operations such as retrieving, creating, updating, and deleting resources.

• Authorization & Authentication
• Upload Images
• CRUD (Products, Categories, User)
• Whitelisting JWT
• Error Handling & Validation

• Node.js
• Express.js
• Prisma (connect database)
• ImageKit (for storing images)
• JSON Web Token (authorization)
• Vercel (for deploying)
• and other packages (you can see in package.json)

• Node.js
• RDBMS Database
• ImageKit

1. Clone this repository to your local

   git clone https://github.com/nyannss/klontong-express.git

2. Install dependencies

   cd klontong-express && npm install

3. Setup environments (you can see in .env.example)

   • Relational database management system such as MySQL, PostgreSQL, etc (see more instructions)

     DATABASE_URL="mysql://johndoe:randompassword@localhost:3306/mydb"

   • JSON Web Token Secret Key (prefer using random string) [see more information]

     JWT_SECRET_KEY = (put your secret key)

   • Image server using ImageKit [you can create account in here]. Get them from dashboard

     IMAGEKIT_ENDPOINT=(imagekit endpoint)
     IMAGEKIT_PUBLIC_KEY=(imagekit public key)
     IMAGEKIT_PRIVATE_KEY=(imagekit private key)

4. Last, run the app

   npm run start

You can see the documentation from Postman

If you using json file, just open your postman and click import.

You can see just in this link.

Run this to start migrate database

npx prisma migrate deploy

• kelontong-vite - Vite React

• nyannss

This project using ISC License

Any error report you can pull request or contact: nyannss@proton.me