format: file name, description, operations, authorization level
The GiveMore web application is designed to create a platform for charities and users to connect. It is an innovative online donation platform designed with a goal to improve resource acquisition and transparency for charitable organizations. It uses various technologies, including Tailwind CSS, Next.js, and Headless UI. This documentation will guide you through the setup, available operations, and authorization levels.
To get started with this template, first install the npm dependencies:
npm installNext, run the development server:
npm run devFinally, open http://localhost:3000 in your browser to view the website.
To learn more about the technologies used in GiveMore, consult the following resources for each:
- Tailwind CSS - The official Tailwind CSS documentation framework.
- Next.js - The official Next.js documentation to understand how Next.js works and its features.
- Headless UI - The official Headless UI documentation.
The homepage represents the homepage of Givemore. This includes a simple page as to what exactly is GiveMore. Users would be able to view the different charity organizations and posts regarding each organization.
- List of Charities
- List of Posts
- Associated with charity table
- Associated with campaign posts table
All users are authorized to access this resource.
For charity members of specific charity organizations to create their accounts.
- Sign Up
all users
A component page within platform, for all users to login into their account and the website.
- Login
All users
A component page within platform, to input a new password incase it is forgotten
- New Password with new password and confirm password details.
All users
A component page within the GiveMore platform, for new users to create an account in the website. Primarily made for donors.
- Sign Up
All users.
A component page within the GiveMore platform, for new users to create an account in the website. Primarily made for charity organizations.
- Sign Up
All users
A component page within the GiveMore platform, for users to reset their account password in the web application.
- Reset Password
All users
The homepage of given charity.
- charity by id
- joined by charity id
- joined by campaign post table
- In kind donation
- Cash donation
All users
Oi fix this, it should be by event id
- event by id
- List of beneficiaries item
- Associated with Beneficiaries item table
- Associated with expenses
All users
OI fix this, it should by news id
- campaign post by id
All users
This is the report charity page, where donors are able to report charity organizations
- Associated with donor complaints table
all users
The application page, where all the request of charity organizations that would like to use the platform.
- List of applications
- Associated with applications table = Approve request = New Charity Organization within the platform
- Associated with applications table = Deny request = The applying Charity Organization is then denied in the platform.
Admins
The audit log page, where all the actions made by Admins are logged.
- List of audit log
- Associated with log table - Filtered by Admins only
Admins
The complaints page, where all the donors complaint against a charity organization is located here.
- List of donor complaints table
- Associated with donor complaints table
- Notify Charity = The complained charity organization is notified of a complaint made by a donor.
Admins
The organizations page, where all the approved and verified charity organizations are located.
- List of charity filtewred by verified
Admins
The profile history page, where all the approved and verified charity organizations are located. A comprehensive record of actions and activities performed by administrators. This page serves as an audit trail.
- List of Audit log
- Associated with Log table = Filtered by Admin user history
Admins
The settings page, a hub for administrators to configure and customize various aspects of the system. One of its key functionalities is the ability to invite new developer admins into the platform.
- Associate with Admins table = Invite new Admininstrators in the platform
Admins
The view charity page, provides an overview of the charity organization. Allows Admins to view submitted complaints against the organization and view the appeals made by the charity organization against the complaints.
- List of donor complaints
- Associated with donor complaints table
- Freeze Charity - To freeze the charity to make it hidden from the web platform.
Admins
STILL EMPTY NEED UPDATE TO UI
The contact page has the capability to add new beneficiaries and edit their details to ensure accuracy.
- List of beneficiaries
- Associated with beneficiaries table
- Associated with beneficiaries table = To add new beneficiaries
- Assign with event
- Associated Images with beneficiaries
- Associated with beneficiaries table = To edit existing beneficiaries
- Assign with event
- Replace Uploaded Associated Images with beneficiaries
- Associated with beneficiaries table = To Delete Existing Beneficiary
- Associated Images with beneficiaries
Charity Members
The event page has the capability to add new events and edit their details to ensure accuracy or delete the event entirely. It has the name of the event and details regarding it.
- List of events
- To add new events
- Associated with Events table
- Associated Item donations
- Associated Cash Donations
- Associated Beneficiaries table
- To edit existing events
- Associated with Events table
- Associated Item donations
- Associated Cash Donations
- Associated Beneficiaries table
- Delete Existing events
Charity Members
The expenses page to add external expenses and edit their details to ensure accuracy or delete it entirely. Details include amount, description, and Images for evidence of the said expense.
- List of Expenses
- Add new expenses
- Associated Images for evidence
- Associated Event table
- Edit existing expenses
- Associated Images for evidence
- Associated Event table
- Delete Existing expenses
Charity Members
The given items page is the inkind donations, it lists the inkind donations and edit their details to ensure accuracy or delete it entirely. Details include amount, description, and Images for evidence of the said expense.
- List of beneficiary item
- Associated Images for evidence
- Associated Beneficiary Item
- Add new beneficiary item
- Associated Images for evidence
- Assign inventory item
- assign event
- Edit existing beneficiary item
- Associated Images for evidence
- Assign inventory item
- assign event
- Delete beneficiary item
Charity Members
The cash page is the external income
- List of external income
- Add new external income
- Assign donor
- photo proof
- edit if added by donor
- Delete existing external income
Charity Members
The donor profile history page, where all the history of donations of the donor is located. This page serves as an audit trail for the donors.
- List of cash
- List of inventory item
- Associated with cash table = Filtered by Donor User
- Associated with inventory item table = Filtered by Donor User
Charity Member
The donor profile history page, where all the history of donations of the donor is located. This page serves as an audit trail for the charity members.
- List of cash
- List of inventory item
- Associated with cash table = Filtered by Donor User
- Associated with inventory item table = Filtered by Donor User
Charity Member
The donor profile history page, where all the history of donations of the donor is located. This page serves as an audit trail for the charity members.
- List of cash
- List of inventory item
- Associated with cash table
- Associated with inventory item table
Charity Member
The inventory page, where all the inventory of the charity donations are located.
- List of inventory item
- Associated with inventory item table
- Add new inventory item
- Associated with inventory item table
- Edit existing inventory item
- Associated with inventory item table
- Delete existing inventory item
Charity Member
The pickup page, where all the unverified inkind donations of the charity donations are located.
- List of unverified inkind donations
- Associated with item donation transaction table
- Associated with inventory table
- Associated with Images for evidence
- Add new unverified inkind donations
- Associated with item donation transaction table
- Associated with inventory table
- Edit existing unverified inkind donations
- Associated with item donation transaction table
- Associated with inventory table
- Delete unverified inkind donations
Charity Member
The verified Inkind page, where all the verified inkind donations of the charity donations are located.
- List of verified inkind donations
- Associated with item donation transaction table = Filtered by verified = true
- Associated with inventory table
- Associated with Images for evidence
- Add new verified inkind donations
- Associated with item donation transaction table
- Associated with inventory table
- Edit existing verified inkind donations
- Associated with item donation transaction table
- Associated with inventory table
- Delete verified inkind donations
Charity Member
The member action page, where all the actions of each charity memeber are logged.
- List of logs = Filtered by charity members
- Associated with log table
Charity Member
The complaints page, where all the complaints of the charity organization is located. The charity members may appeal each complaint made to them towards the admins.
- List of complaints = Filtered by donors complaints against the specific charity organization
- Details of complaint
- Associated with donor omplaints table
- Add new appeal against complain
- Associated with charity appeals
Charity Member
The posts page, where all the posts of the charity organization is located. The charity members may create a post and the donors would be able to view it.
- List of campaign post = Filtered by charity organization's post
- Associated with campaign post table
- Add new appeal against complain
- Associated with campaign post table
- Edit existing campagn post table
- Associated with campaign post table
- Delete existing campaign post
Charity Member
The statistics page, an overview data visualization of charity donations and expenses.
- Data Visualization Chart of Charity Donations and expenses
- Associated with expenses table
- Associated with cash table
Charity Member
The onboarding details page, where charity organizations would request to sign up in the platform.
- Sign Up
Charity member and Admin
The pending page, where charity organizations would be shown their status as pending after onboarding.
Charity member and Admin
The report process page, where donors would be shown their complaint status after filling up the form.
Charity member
The donation history page, where donors would be shown their history of donation.
- List of cash
- List of inventory item
- Associated with cash table
- Associated with inventory item
Charity member
The thank you page, where donors would be shown their complaint status after filling up the form.
Charity member
The posts page is where the charity members may create and manage existing posts made to the GiveMore platform.
- List of posts
- Create new posts
- Edit existing posts
- Delete existing posts