From 9bda6b85b0100391eb064ae8d303435fa1fe828c Mon Sep 17 00:00:00 2001
From: Aulia  Nadhirah Yasmin Badrulkamal <18221066@std.stei.itb.ac.id>
Date: Mon, 27 Nov 2023 16:40:52 +0000
Subject: [PATCH] Update README.md

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index 48d6aa7..a76687f 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,31 @@
 
 Karsus adalah aplikasi manajemen kursus mengemudi yang berbentuk perangkat lunak berbasis web. Aplikasi kami dapat digunakan untuk melihat dan mengelola berbagai data yang dimiliki oleh kursus pengemudi seperti data kendaraan, instruktur, siswa dan kelas. Karsus juga dilengkapi oleh kemampuan authentication sehingga pemilik kursus dapat mengatur admin yang akan mengelola data yang ada dan melindungi data tersebut dari pihak yang tidak berkenan. 
 
+# Penjelasan Singkat
+Karsus adalah aplikasi manajemen kursus mengemudi yang berbentuk perangkat lunak berbasis web. Aplikasi kami dapat digunakan untuk melihat dan mengelola berbagai data yang dimiliki oleh kursus pengemudi seperti data kendaraan, instruktur, siswa dan kelas. Karsus juga dilengkapi oleh kemampuan authentication sehingga pemilik kursus dapat mengatur admin yang akan mengelola data yang ada dan melindungi data tersebut dari pihak yang tidak berkenan. 
+
+## Cara Menjalankan Aplikasi
+### Requirements 
+1. NPM 9.6.6 or above
+2. Node v20.2.0
+
+### How to run the backend server
+1. Clone the BE repository
+2. Add the `.env` folder in root (this file will have to be given, considering it contains the password to the database)
+3. run `npm install` to install every dependencies
+4. run `npx prisma generate` to generate a prisma client
+5. run `prisma db pull` to make sure it is up to date with the database
+6. run `npm run dev` to start the server
+7. you can use the BE in `http://localhost:5000/`
+
+### How to run the frontend of the website
+1. Clone the FE repository
+2. run `npm install` to install every dependencies
+3. run `npm run dev`
+
+### How to run testing di the BE
+1. Make sure that you have done the steps above to install every dependencies needed
+2. in the root folder, you should be able to run `npm run test` or `npx jest`
 
 ## Daftar Use Case
 
-- 
GitLab