Skip to content

limrik/big-heart-bros

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

big-heart-bros

Big Heart Bros aim to streamline the volunteering process, by allowing volunteers to sign up for events and organisations to put up requests for volunteers to join. Big At Heart simply have to approve or reject the request from the organisations.

  • Target User: Volunteers

  • Medium: Web app

  • Issue: Tedious process to sign and liase with volunteeers, and meaningful data collection

  • Additional Features:

  1. Recommender system to allow volunteers to have a more personalised experience
  2. GenAI tools for testimonial for volunteers that will consolidate their volunteering experiences
  3. Personalised statistics for volunteers
  4. Sign-up and sign-in feature for volunteers (and data collection)

User Flow

User Flow Diagram

Landing Page

Home Page

Sign In & Up Page

Sign Up Page
Purpose: Users will be redirected to this page upon first sign in. Comprehensive user page for meaningful data collection.
Usage: Users can fill up the input fields and sign up as a user. Users are also authenticated against a database using NextAuth.js.

Volunteering Page

Volunteering Page Volunteering Sign up
Purpose: Generates personalised events page, with a recommender system to match skills wanted by organisations with those users have.
Usage: Users can click on "View Event", which will lead to a pop-up event-sign page, where users can view more information and join the event, viewing other info such as capacity, and registration deadline.

User Dashboard

User Dashboard Upcoming Events Generate Testimonial 1 Generate Testimonial 2
Purpose: Gamify volunteering and allowing users to get achievements and see their stats (from volunteering).
Usage: Under "Activity", users can view their hours clocked. Users can also view events they signed up for under "Upcoming Events" and those that are completed under "Historical Events". We have integrated our web application with the OpenAI API allow Users to receive a testimonial put together from the feedback they have received from various organisations they have volunteered with.

Organisation Dashboard

Organisation Dashboard Organisation Dashboard Organisation Dashboard Organisation Dashboard
Purpose: Allow beneficiaries to track their events and apply for new events to Big At Heart.
Usage: Beneficiaries can press "View Event" at the right of each event to view their event information. They can also create new events under the "Create Event" button. Beneficiaries can also mark attendance of volunteers and give feedback to volunteers to acknowledge their contributions.

Admin Dashboard

Organisation Dashboard Organisation Dashboard Organisation Dashboard Organisation Dashboard
Purpose: Allow Big At Heart to view all pending and approved events.
Usage: Admin can press "Pending" to view events awaiting approval and press the ":" button on the left to view/approve the events. After pressing "View", users will be brought to another page with event information and approval button below.

Tech Stack and Configuration

This app uses:

  • Next.js
  • Nativewind CSS (Tailwind)
  • NextAuth.js
  • TypeScript
  • Prettier (Auto formatting)
  • Prisma
  • Supabase

Folder structure

├── src/  
│   ├── app  
│   ├── components  
│   ├── constants  
│   ├── lib  
│   └── pages/api  
└── prisma
└── docs

Get Started

Visit this link: big-heart-bros.vercel.app/home

Known issues:

  • If NextAuth not working on Vercel, can consider dropping us an issue to see video demo or for the .env file.

Alternatively,

Ensure that you have the following installed:

Now do the following:

  1. First git clone the repository
  2. Then cd into the repository (cd big-heart-bros/big-heart-bros) and install dependencies with npm install
  3. Run npm run dev to run the application
  4. Go to localhost:3000 on your own device
  5. Drop us an issue for the .env file

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •