From 2cf15b0016e9f29f3e2c7c691d33dd2a91848127 Mon Sep 17 00:00:00 2001
From: Derek Gan <187380048+derekgan08@users.noreply.github.com>
Date: Sat, 7 Jan 2023 01:35:17 +0800
Subject: [PATCH] Update README.md
---
README.md | 200 +++++++++++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 190 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 304013c..d80385d 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,196 @@
-# flutter_project_template
+# CAT304 Project: cuzVcare Mobile App
-A new Flutter project.
+## Problem Statements
+Volunteering organizations and volunteers often struggle with managing and tracking events effectively. With disparate systems for event registration, attendance tracking, and rewards, both volunteers and organizations face numerous inefficiencies and challenges such as:
-## Getting Started
+- **Low Discoveries of Event Information:** There are a lot of volunteers out there who are keen on participating these activities but due to there is no specific platform to host all these information at the same platform to ease discovery, many of them are not aware that these activities are going on.
-This project is a starting point for a Flutter application.
+- **Activities Signups and Participations:** Participants who are interested in taking part in the activities will sometimes forget the activity, date, time or the venue due to forgetful. Some of them who have signed up for the activity but are absent due to various reasons, which will result in the number of participants who have signed up is lesser than the number of participants who are actually turning up in the activities.
-A few resources to get you started if this is your first Flutter project:
+- **Difficulties in Conveying Messages:** In the event of unexpected issues such as rain, inevitable postponement of activities, change of activities details etc., announcements or updates such as the new date and time are difficult to convey to all the participants. Hence, a lot of them are not aware of the latest arrangements. Even if we can use phone calling to notify them one by one, it will be tedious if many participants is involved.
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+- **Activity Records Management:** Mostly, all the activity records are either incomplete or not well documented. Even if the records are complete, they are not shared with others. This results in future activities do not having enough references and difficult to find solutions when necessary.
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+- **Lack of Awareness and Motivation in Event Participation:** Even if some people have discovered the activity, there are very less of them who would like to join because they think these activities are wasting time. Some of them might feel that the event information provided is not attractive enough to motivate them to participate.
+
+- **Vulnerability of Sensitive Information:** Most of the time, the organizers will collect the information of participants when they sign up for an activity. The information is not guaranteed to be safe and is at the risk of being stolen or exposed.
+
+- **Lack of interaction platform:** The difficulty in coordinating and communicating effectively among volunteers due to a lack of a dedicated online platform for managing and organizing volunteer efforts.
+
+## Project Overview
+Unsustainable cities and human settlements is one of the major issue in the current world and is particularly severe in poor countries. In around the world, pollutions, waste management, and natural disasters are prevalent issues and actions must be taken to mitigate it. However, volunteering activities, as one of the most effective mitigating methods, is lacking and not carried out profusely. One of the main reasons is because there is no focused, organized, secure and trustworthy communication hub to host volunteering activity information. We aim to reduce these issues by engineering a volunteer recruitment platform named “cuzVcare”. The platform aims to host all the event information on the same platform while motivate users in participating events, allow users to discover and sign up for the events they would like to join as well as enable the users to keep track the events they have signed up and bookmark the events they are interested to join.
+
+cuzVcare is designed to streamline the management and participation of volunteering events developed as a mobile application which can be run on Android and iOS Operating Systems as mobile application has the highest volume of users in the current trend. This application can be used by anyone from any part of the world in order to create a more sustainable cities and human settlements as aligned with Sustainable Development Goals (SDG) 11.
+
+The app serves as an efficient tool to encourage volunteering, making it easier for users to engage with local events and be rewarded for their contributions.
+
+## Key Features
+- **Event Submission**: Organisers can submit their event details to be featured on the platform.
+- **Event Tracking**: Users can track past volunteering events and view submission statuses (Pending/Approved/Rejected).
+- **Event Signup**: Volunteers can register for events and check-in to track their attendance.
+- **GPS Filtering**: Volunteers can find nearby events based on their location.
+- **Rewards Redemption**: Volunteers can redeem their earned points for rewards from partnered organizations.
+- **Chat and Notifications**: Seamless communication through notifications and chat for event updates and reminders.
+
+## Technologies Used
+- **Flutter:** Cross-platform mobile application framework for building iOS and Android apps.
+- **Firebase:** Backend-as-a-service solution for user authentication, data storage, and notifications.
+- **Dart:** The programming language used for developing the app.
+- **Figma:** Design tool used for creating the app's user interface and user experience designs.
+- **Android Studio:** Integrated development environment (IDE) used for Flutter development and testing on Android devices.
+
+## Installation
+This project is not open for public cloning or redistribution without prior written permission from the author as stated in . If you would like to access this project, please reach out to the repository owner to request permission.
+
+Once written permission is granted, you will receive detailed instructions on how to install and run the system, including all necessary steps and dependencies.
+
+## Usage
+Similar to the installation process, usage instructions will be provided only after written permission is granted to access this repository. Upon receiving access, you will be provided with step-by-step instructions on how to use this system/application, including on how to run the program, interact with it and exploring all the key features stated.
+
+## Screenshots
+1. **Onboarding Screen:**
+
+ 
+
+ Figure 1: Onboarding Screen
+
+
+2. **Sign Up Screen:**
+
+ 
+
+ Figure 2: Sign Up Screen
+
+
+3. **Log In Screen:**
+
+ 
+
+ Figure 3: Log In Screen
+
+
+4. **Create Profile Screen:**
+
+ 
+
+ Figure 4: Create Profile Screen
+
+
+5. **Home Page Screen:**
+
+ 
+
+ Figure 5: Home Page Screen
+
+
+6. **View Event Detail:**
+
+ 
+
+ Figure 6: View Event Detail
+
+
+7. **View Event Ticket:**
+
+ 
+
+ Figure 7: View Event Ticket
+
+
+8. **View Joined Events:**
+
+ 
+
+ Figure 8: View Joined Events
+
+
+9. **View Bookmarked Events:**
+
+ 
+
+ Figure 9: View Bookmarked Events
+
+
+10. **View All Rewards:**
+
+ 
+
+ Figure 10: View All Rewards
+
+
+11. **View Redeemed Rewards:**
+
+ 
+
+ Figure 11: View Redeemed Rewards
+
+
+12. **Create Event Form Part 1:**
+
+ 
+
+ Figure 12: Create Event Form Part 1
+
+
+13. **Create Event Form Part 2:**
+
+ 
+
+ Figure 13: Create Event Form Part 2
+
+
+14. **View All Chat Messages:**
+
+ 
+
+ Figure 14: View All Chat Messages
+
+
+15. **Send and Receive Messages:**
+
+ 
+
+ Figure 15: Send and Receive Messages
+
+
+16. **View User Profile:**
+
+ 
+
+ Figure 16: View User Profile
+
+
+17. **Edit User Profile:**
+
+ 
+
+ Figure 17: Edit User Profile
+
+
+18. **View Notification:**
+
+ 
+
+ Figure 18: View Notification
+
+
+19. **Side Drawer Menu Screen:**
+
+ 
+
+ Figure 19: Side Drawer Menu Screen
+
+
+20. **About Us Screen:**
+
+ 
+
+ Figure 20: About Us Screen
+
+
+21. **Log Out Screen:**
+
+ 
+
+ Figure 21: Log Out Screen
+
\ No newline at end of file