diff --git a/README.md b/README.md index f9fb6857d7467c3d0e96444d6106cae2f37f0133..88575b6dec808702f7f47be1a308bcd2b78f2c9a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# KURSUS MENGEMUDI RPL BY ***HELMI*** +# 🚘 KURSUS MENGEMUDI RPL BY ***HELMI*** 🚗💨 Disusun oleh **K2_G14** yang beranggotakan : - Michelle Lim / 18221052 - Esther Regina / 18221086 @@ -8,11 +8,42 @@ Disusun oleh **K2_G14** yang beranggotakan : ## Penjelasan Singkat Aplikasi Kursus Mengemudi RPL adalah aplikasi untuk melakukan pendaftaran kursus mengemudi oleh calon pelanggan 🚘. Aplikasi ini juga memungkinkan owner untuk mengelola data kelas, akun admin, informasi perusahaan & FAQ, data kendaraan, data instruktur. Selain itu, aplikasi ini juga memungkinkan admin untuk mengelola data pelanggan. -## Cara menjalankan aplikasi untuk development backend +## Cara menjalankan aplikasi untuk development backend pada localhost +1. Jalankan command ```npm install``` pada terminal untuk menginstal semua modul yang diperlukan untuk menjalankan aplikasi. + +2. Buatlah file ```.env``` pada root folder. + + file .env : + ``` + PORT=3333 + NODE_ENV=dev + MONGO_URI=mongodb+srv://admin:admin@cluster0.agwt2ah.mongodb.net/?retryWrites=true&w=majority + + JWT_AUDIENCE=localhost:3000 + JWT_ISSUER=localhost:3333 + JWT_KEY=ee26b0dd4af7e749aa1a8ee3c10ae9923f618980772e473f8819a5d4940e0db27ac185f8a0e1d5f84f88bc887fd67b143732c304cc5fa9ad8e6f57f50028a8ff + + REDIS_URL=redis://default:NeIOpPCkBNg1pPgiFIFF4l6bC1L42eeD@monorail.proxy.rlwy.net:36462 + ``` + +3. Untuk menjalankan aplikasi secara lokal, buka dua tab terminal pada IDE. Pada terminal pertama, jalankan command ```tsc -w``` dan pada terminal satunya, jalankan ```npm run dev``` secara bersamaan. + +4. Test keberjalanan backend aplikasi menggunakan ```Postman```. ## Cara menjalankan aplikasi untuk development frontend pada localhost +1. Jalankan command ```npm install``` pada terminal untuk menginstal semua modul yang diperlukan untuk menjalankan aplikasi. + +2. Jalankan ```npm run dev``` untuk menjalankan aplikasi. + +3. Buka ```localhost:3000``` pada browser untuk mengakses frontend aplikasi dan memantau perubahan yang dilakukan terhadap source code. + +## Cara menjalankan aplikasi secara remote melalui web address yang telah di-deploy +1. Buka https://rpl-frontend-psi.vercel.app/ + +## Cara menjalankan testing aplikasi +1. Jalankan command ```npm install``` pada terminal untuk menginstal semua modul yang diperlukan untuk menjalankan aplikasi -## Cara menjalankan aplikasi secara remote melalui web address yang telah di-deploy. +2. Jalankan command ```npm test``` pada terminal ## Daftar use case yang diimplementasi **1. Melihat informasi kelas, FAQ, dan informasi perusahaan** <br>