diff --git a/README.md b/README.md index 5614db31c485058c8277b93c72a82d02c6d04a21..08f8a49b1616312cd6b0e39a969974cf68fc1802 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,303 @@ Berikut adalah hal yang harus diperhatikan untuk pengumpulan tugas ini: * 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). + +<!-- LOGO --> +<br /> +<div align="center"> + <a href="https://github.com/ditramadia/IF2210_TB2_NGE"> + <img src="assets/NutriCraft.svg" alt="Logo" width="120"/> + </a> + +<h3 align="center">NutriCraft</h3> + + <p align="center"> + Tugas Besar Milestone 1 + <br /> + IF3110 Web Based Development + <br /> + <br /> + <br /> + </p> +</div> + + + + +<!-- ABOUT THE PROJECT --> +## About The Project + +NutriCraft adalah aplikasi berbasis web yang dibuat untuk memudahkan user dalam mengatur nutrisi mereka. web ini dapat menampilkan daftar makanan dengan bahan-bahan serta kandungan nutrisinya dengan lengkap. + + + +### Built With + +*  +*  +*  + +### Project Structure +```ssh +. +├─── app # Source code +│ ├── controllers + ├─── addfact.php + ├─── addmeal.php + ├─── cms.php + ├─── detailmeal.php + ├─── editfact.php + ├─── editmeal.php + ├─── fact.php + ├─── home.php + ├─── login.php + ├─── meals.php + ├─── profile.php + └─── register.php + ├── core + ├─── app.php + └─── controller.php + ├── views + ├─── addfact + └─── index.php + ├─── addmeal + └─── index.php + ├─── cms + └─── index.php + ├─── detailmeal + └─── index.php + ├─── editfact + └─── index.php + ├─── editmeal + └─── index.php + ├─── fact + └─── index.php + ├─── home + └─── index.php + ├─── login + └─── index.php + ├─── meals + └─── index.php + ├─── profile + └─── index.php + └─── register + └─── index.php +│ └─── init.php +├─── assets + ├─── admin + ├─── content + └─── meals +├─── public + ├─── css + ├─── addfact.css + ├─── addmeal.css + ├─── cms.css + ├─── detailmeal.css + ├─── editfact.css + ├─── editmeal.css + ├─── fact.css + ├─── home.css + ├─── login.css + ├─── meals.css + ├─── profile.css + └─── register.css + └─── js + ├─── cms + ├─── fact.js + ├─── meal.js + ├─── addfact.js + ├─── addmeal.js + ├─── detailmeal.js + ├─── editfact.js + ├─── editmeal.js + ├─── fact.js + ├─── home.js + ├─── login.js + ├─── meals.js + ├─── profile.js + └─── register.js +├─── server + ├─── controller + └─── auth + ├─── cms + ├─── AddFact.php + ├─── AddMeal.php + ├─── DeleteMealAndFact.php + ├─── EditMeal.php + ├─── EditFact.php + ├─── Fact.php + └─── Meals.php + ├─── DetailFact.php + ├─── DetailMeal.php + ├─── Fact.php + ├─── Login.php + ├─── Meals.php + ├─── Profile.php + └─── Register.php + ├─── db + └─── Database.php + ├─── di + └─── InitialData.php + ├─── handler + ├─── data + └─── utils +├─── .dockerignore +├─── .env +├─── docker-compose.yml +├─── Dockerfile +├─── index.php +├─── Makefile +└─── README.md +``` +<br/> +<br/> + +<!-- GETTING STARTED --> +## Getting Started + + + +### Installation +1. Clone the repo + ```sh + git clone https://gitlab.informatika.org/IF3110-2023-01-K3/tugas-besar-1.git + ``` +2. Go to the repository root folder `tugas-besar-1` + ```sh + cd tugas-besar-1 + ``` +3. Install Docker Desktop + ```sh + https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe?utm_source=docker&utm_medium=webreferral&utm_campaign=dd-smartbutton&utm_location=module + ``` + +4. Log in to your Docker account + +5. Run the Docker server + ```sh + docker compose build + docker compose up + ``` +6. Open the website + ```sh + http://localhost:3000 + ``` +<br/> +<br/> + +<!-- USAGE --> +## Pages + +1. Home + <br/> + <br/> <img src="assets/screenshots/homepage.png" alt="Home Page" width="1280"> + <br/> + <br/> +2. Register + <br/> + <br/> <img src="assets/screenshots/registerpage.png" alt="Edit item page" width="1280"> + <br/> + <br/> +3. Login + <br/> + <br/> <img src="assets/screenshots/loginpage.png" alt="Edit item page" width="1280"> + <br/> + <br/> +4. Meals + <br/> + <br/> <img src="assets/screenshots/mealspage.png" alt="Item detail page" width="1280"> + <br/> + <br/> +5. Facts + <br/> + <br/> <img src="assets/screenshots/factspage.png" alt="Add item page" width="1280"> + <br/> + <br/> +6. Profile + <br/> + <br/> <img src="assets/screenshots/profilepage.png" alt="Edit item page" width="1280"> + <br/> + <br/> +7. Confirmation + <br/> + <br/> <img src="assets/screenshots/confirmationbox.png" alt="Edit item page" width="1280"> + <br/> + <br/> +8. CMS meal + <br/> + <br/> <img src="assets/screenshots/cmsadminmealpage.png" alt="Edit item page" width="1280"> + <br/> + <br/> +9. CMS fact + <br/> + <br/> <img src="assets/screenshots/cmsadminfactpage.png" alt="Edit item page" width="1280"> + <br/> + <br/> +10. Add meal + <br/> + <br/> <img src="assets/screenshots/addmealpage1.png" alt="Edit item page" width="1280"> + <br/> + <br/> <img src="assets/screenshots/addmealpage2.png" alt="Edit item page" width="1280"> + <br/> + <br/> +11. Add fact + <br/> + <br/> <img src="assets/screenshots/addfactpage.png" alt="Edit item page" width="1280"> + <br/> + <br/> +12. Edit meal + <br/> + <br/> <img src="assets/screenshots/editmealpage.png" alt="Edit item page" width="1280"> + <br/> + <br/> +12. Edit fact + <br/> + <br/> <img src="assets/screenshots/editfactpage.png" alt="Edit item page" width="1280"> + <br/> + <br/> + + +<!-- AUTHOR --> + +## Authors + +| NIM | Name | +|:--------:|:----------------------:| +| 13521005 | Kelvin Rayhan Alkarim | +| 13521011 | Afnan Edsa Ramadhan | +| 13521031 | Fahrian Afdholi | + +## Task Distribution + +Server-side +<br> +* Login : 13521xxx, 13521xxx +* Register : 13521xxx +* Meals : 13521005, 13521xxx +* DetailMeal : 13521005 +* Fact : 13521xxx +* Navbar : 13521xxx, 13521xxx +* Profile : 13521xxx +* CMS meal : 13521005 +* CMS fact : 13521xxx + + +Client-side +<br> +* Login : 13521005, 13521xxx +* Register : 13521005 +* Meals : 13521005, 13521xxx +* DetailMeal : 13521005 +* Fact : 13521005 +* Navbar : 13521005, 13521xxx +* Profile : 13521xxx +* CMS meal : 13521005 +* CMS fact : 13521005 + + + + +<!-- MARKDOWN LINKS & IMAGES --> +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> +[product-screenshot]: public/home-page.png + diff --git a/assets/screenshots/addfactpage.png b/assets/screenshots/addfactpage.png new file mode 100644 index 0000000000000000000000000000000000000000..2b59abd5a3a9ad81830ab33e7d34966c523c7159 Binary files /dev/null and b/assets/screenshots/addfactpage.png differ diff --git a/assets/screenshots/addmealpage1.png b/assets/screenshots/addmealpage1.png new file mode 100644 index 0000000000000000000000000000000000000000..1e13ddae1457b8deced6973ecbba8aa8dec460bd Binary files /dev/null and b/assets/screenshots/addmealpage1.png differ diff --git a/assets/screenshots/addmealpage2.png b/assets/screenshots/addmealpage2.png new file mode 100644 index 0000000000000000000000000000000000000000..572c476e47daf74af4af82912671c39b2f76807e Binary files /dev/null and b/assets/screenshots/addmealpage2.png differ diff --git a/assets/screenshots/cmsadminfactpage.png b/assets/screenshots/cmsadminfactpage.png new file mode 100644 index 0000000000000000000000000000000000000000..2c6c95948e227cf13d381f3845699570da36fcbd Binary files /dev/null and b/assets/screenshots/cmsadminfactpage.png differ diff --git a/assets/screenshots/cmsadminmealpage.png b/assets/screenshots/cmsadminmealpage.png new file mode 100644 index 0000000000000000000000000000000000000000..dcbd3a8971e7bd81db7618dc6b16d6f82c014ef8 Binary files /dev/null and b/assets/screenshots/cmsadminmealpage.png differ diff --git a/assets/screenshots/confirmationbox.png b/assets/screenshots/confirmationbox.png new file mode 100644 index 0000000000000000000000000000000000000000..21e74469351dde8b856664a16225e6596bc815e0 Binary files /dev/null and b/assets/screenshots/confirmationbox.png differ diff --git a/assets/screenshots/detailmealpage.png b/assets/screenshots/detailmealpage.png new file mode 100644 index 0000000000000000000000000000000000000000..b6ef7fd5e6efa1904c7f585e8c4b2b283068fcfd Binary files /dev/null and b/assets/screenshots/detailmealpage.png differ diff --git a/assets/screenshots/editfactpage.png b/assets/screenshots/editfactpage.png new file mode 100644 index 0000000000000000000000000000000000000000..2311b2cc786f3fd71588c028f7dd5707df025727 Binary files /dev/null and b/assets/screenshots/editfactpage.png differ diff --git a/assets/screenshots/editmealpage.png b/assets/screenshots/editmealpage.png new file mode 100644 index 0000000000000000000000000000000000000000..88c71f3c97909fe328194bf56c06ba2b05c8d50e Binary files /dev/null and b/assets/screenshots/editmealpage.png differ diff --git a/assets/screenshots/factspage.png b/assets/screenshots/factspage.png new file mode 100644 index 0000000000000000000000000000000000000000..d38cf182218f57bcfc4f9bc6311965f567318201 Binary files /dev/null and b/assets/screenshots/factspage.png differ diff --git a/assets/screenshots/homepage.png b/assets/screenshots/homepage.png new file mode 100644 index 0000000000000000000000000000000000000000..3bc2bcd1d370825e4a7296fe66778aeb9b796518 Binary files /dev/null and b/assets/screenshots/homepage.png differ diff --git a/assets/screenshots/loginpage.png b/assets/screenshots/loginpage.png new file mode 100644 index 0000000000000000000000000000000000000000..299d32f6900980733d2f4cdf43d8350372226890 Binary files /dev/null and b/assets/screenshots/loginpage.png differ diff --git a/assets/screenshots/mealspage.png b/assets/screenshots/mealspage.png new file mode 100644 index 0000000000000000000000000000000000000000..10d307f28bd78e1a02a89d542e852ab7168f87fb Binary files /dev/null and b/assets/screenshots/mealspage.png differ diff --git a/assets/screenshots/profilepage.png b/assets/screenshots/profilepage.png new file mode 100644 index 0000000000000000000000000000000000000000..961a89d99294e66e4ef072449b2f3c31eaacf071 Binary files /dev/null and b/assets/screenshots/profilepage.png differ diff --git a/assets/screenshots/registerpage.png b/assets/screenshots/registerpage.png new file mode 100644 index 0000000000000000000000000000000000000000..2b22ea88a6a782356d47dd8ba40a18b54c78b75b Binary files /dev/null and b/assets/screenshots/registerpage.png differ