From 1cac2d9f5c2e5640374052c34eeef19d5d6f9e9d Mon Sep 17 00:00:00 2001 From: NaufalArdanni <54439087+NaufalArdanni@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:45:19 +0700 Subject: [PATCH] docs: update readme --- README.md | 120 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 100 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 5614db3..fc71a4f 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,100 @@ -## Panduan Pengerjaan -Berikut adalah hal yang harus diperhatikan untuk pengumpulan tugas ini: -1. Buatlah grup pada Gitlab dengan format "IF3110-2023-01-XX", dengan XX adalah nomor kelompok (untuk K1 dan K2) atau kode kelompok (untuk K3). -2. Tambahkan anggota tim pada grup anda. -3. **Fork** pada repository ini dengan organisasi yang telah dibuat. -4. Ubah hak akses repository hasil Fork anda menjadi **private**. -5. Hal-hal yang harus diperhatikan. - * Silakan commit pada repository anda (hasil fork) - * Lakukan beberapa commit dengan pesan yang bermakna, contoh: “add register formâ€, “fix logout bugâ€, jangan seperti “finalâ€, “benerin dikitâ€, “fix bugâ€. - * Disarankan untuk tidak melakukan commit dengan perubahan yang besar karena akan mempengaruhi penilaian (contoh: hanya melakukan satu commit kemudian dikumpulkan). - * Commit dari setiap anggota tim akan mempengaruhi penilaian. - * Jadi, setiap anggota tim harus melakukan commit yang berpengaruh terhadap proses pembuatan aplikasi. - * Sebagai panduan bisa mengikuti [semantic commit](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716). -6. Buatlah file README yang berisi: - * Deskripsi aplikasi web - * Daftar requirement - * Cara instalasi - * Cara menjalankan server - * Screenshot tampilan aplikasi (tidak perlu semua kasus, minimal 1 per halaman), dan - * Penjelasan mengenai pembagian tugas masing-masing anggota (lihat formatnya pada bagian pembagian tugas). +# Tugas Besar 1 - IF3110 Pengembangan Aplikasi Berbasis Web + +## Deksripsi Aplikasi Web + +Aplikasi web yang dibuat adalah sebuah platform _e-commerce_ sehingga pengguna dapat melakukan pembelian produk secara _online_. Pengguna dapat melakukan pencarian produk. Selain itu, pengguna juga dapat melakukan pembelian produk dengan menambahkannya ke dalam keranjang. Aplikasi web ini juga menyediakan fitur manajemen bagi admin untuk mengelola produk dan kategori. + +## Daftar _Requirement_ + +## Cara Instalasi Server + +1. _Clone_ repositori ini. + +```sh +git clone https://gitlab.informatika.org/if3110-2023-01-36/Tugas-Besar-1.git +``` + +2. Ubah _current directory_ menjadi folder `Tugas-Besar-1`. + +```sh +cd Tugas-Besar-1 +``` + +3. Pastikan telah menginstal dan menjalankan aplikasi Docker. + +4. _Build_ kontainer Docker atau jalankan file bat. + +```sh +docker build -t tubes-1:latest . +``` + +```sh +./scripts/build-image.bat +``` + +4. Buatlah file .env baru berdasarkan .env.example (atau dengan menghapus .example dari nama file). + +```sh +mv .env.example .env +``` + +## Cara Menjalankan Server + +1. Jalankan kontainer Docker. + +```sh +docker compose up -d +``` + +2. Akses aplikasi web di localhost dengan _port_ 8000. + +```sh +http://localhost:8080/ +``` + +3. Hentikan aplikasi web dengan menjalankan + +```sh +docker compose down +``` + +## _Screenshot_ Tampilan Aplikasi + +## Pembagian Tugas + +**Anggota Kelompok** + +| Nama | NIM | +|------------------------------|----------| +| Ulung Adi Putra | 13521122 | +| Naufal Baldemar Ardanni | 13521154 | +| Dewana Gustavus Haraka Otang | 13521173 | + +**<u>Server-side</u>** + +| Fungsionalitas | NIM | +|----------------|----------| +| Basis Data | 13521122 | +| Navbar | 13521154 | +| Home | 13521173 | +| Search | 13521122 | +| Keranjang | 13521173 | +| Manage Toko | 13521154 | +| Profile | 13521154 | +| Login | 13521173 | +| CRUD Produk | 13521173 | +| CRUD User | 13521122 | +| CRUD Keranjang | 13521154 | + +**<u>Client-side</u>** + +| Fungsionalitas| NIM | +|---------------|----------| +| Navbar | 13521154 | +| Home | 13521173 | +| Search | 13521122 | +| Keranjang | 13521173 | +| Manage Toko | 13521154 | +| Profile | 13521154 | +| Login | 13521173 | +| Template Card | 13521122 | \ No newline at end of file -- GitLab