From a7ecaa265f24701d00fb16fce8dcd9557854ad8e Mon Sep 17 00:00:00 2001 From: Teoh Xi Sheng Date: Sun, 27 Oct 2024 16:41:21 +0800 Subject: [PATCH] update README.md --- README.md | 23 +++++++++++++---------- images/frontend_arch.svg | 1 + img_15.png => images/img_15.png | Bin img_16.png => images/img_16.png | Bin img_17.png => images/img_17.png | Bin img_18.png => images/img_18.png | Bin img_19.png => images/img_19.png | Bin img_20.png => images/img_20.png | Bin img_21.png => images/img_21.png | Bin 9 files changed, 14 insertions(+), 10 deletions(-) create mode 100644 images/frontend_arch.svg rename img_15.png => images/img_15.png (100%) rename img_16.png => images/img_16.png (100%) rename img_17.png => images/img_17.png (100%) rename img_18.png => images/img_18.png (100%) rename img_19.png => images/img_19.png (100%) rename img_20.png => images/img_20.png (100%) rename img_21.png => images/img_21.png (100%) diff --git a/README.md b/README.md index 2b9642d..f5164c4 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,7 @@ The **EduQuest Frontend Application** is the user interface component of EduQues Built using the Next.js framework (React-based), the frontend is highly responsive, ensuring a seamless experience across different devices and screen sizes. ## Table of Contents -- [Introduction](#introduction) -- [Table of Contents](#table-of-contents) +- [Architecture Overview](#architecture-overview) - [Demo](#demo) - [Login](#login) - [Dashboard](#dashboard) @@ -24,28 +23,32 @@ Built using the Next.js framework (React-based), the frontend is highly responsi - [Installation](#installation) - [Running the Application](#running-the-application) +## Architecture Overview +

+ Frontend Architecture Diagram +

+ ## Demo ### Login -![img_16.png](img_16.png) +![img_16.png](images/img_16.png) ### Dashboard -![img_17.png](img_17.png) +![img_17.png](images/img_17.png) ### Courses -![img_18.png](img_18.png) +![img_18.png](images/img_18.png) ### Quest Attempt -![img_15.png](img_15.png) +![img_15.png](images/img_15.png) ### Badge Catalogue -![img_19.png](img_19.png) +![img_19.png](images/img_19.png) ### Quest Generator -![img_20.png](img_20.png) +![img_20.png](images/img_20.png) ### Course Insights -![img_21.png](img_21.png) - +![img_21.png](images/img_21.png) ## Key Features: diff --git a/images/frontend_arch.svg b/images/frontend_arch.svg new file mode 100644 index 0000000..d3a9f35 --- /dev/null +++ b/images/frontend_arch.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/img_15.png b/images/img_15.png similarity index 100% rename from img_15.png rename to images/img_15.png diff --git a/img_16.png b/images/img_16.png similarity index 100% rename from img_16.png rename to images/img_16.png diff --git a/img_17.png b/images/img_17.png similarity index 100% rename from img_17.png rename to images/img_17.png diff --git a/img_18.png b/images/img_18.png similarity index 100% rename from img_18.png rename to images/img_18.png diff --git a/img_19.png b/images/img_19.png similarity index 100% rename from img_19.png rename to images/img_19.png diff --git a/img_20.png b/images/img_20.png similarity index 100% rename from img_20.png rename to images/img_20.png diff --git a/img_21.png b/images/img_21.png similarity index 100% rename from img_21.png rename to images/img_21.png