Indonate

The best donation website you will see

Visit Indonate

Figma design

Schema design

Table of Contents

1. About The Project
   • Built With
2. Install application
3. User Journey
   • donor
   • admin
4. User Stories
   • donor
   • admin
5. Contributers

About The Project

For over a decade, Indonate has responded to the hunger crisis, increase of unemployment rate and families without adequate shelter or heating by providing food, clothes and money to people in need through a nationwide network of campaigns. Today, Indonate is the nation’s largest domestic hunger-relief organization—a powerful and efficient network across the country. As the coronavirus pandemic brought record unemployment and instability, Indonate network rose to meet the need. Last year, Indonate network served 1000 families.

back to top

Built With

• Express.js
• React.js
• Typescript
• Redux Toolkit
• Ant Design
• Sequelize
• Cloudinary
• Jest

back to top

User Journey 🚀

As a Donor:

• By entering indonate, Donor will be promoted with a landing page that shows a brief description of the amount of donations collected and spent on families in need, a navbar to navigate through the pages, our mission section, comments and feedbacks from users about the website, a contact form to submit an issue and a section for the latest campaigns that are running with the ability to view all campaigns and search for specific campaign or filter campaigns by desired category.
• When donor clicks on the campaign card, he will be redirected to a page with name, description, donations collected, beneficiary families for that campaign.
• Donate button will be available to press if donor is logged in.
• If donor is not logged in he will be redirected to the login page and will be asked to enter his email and passoword.
• Donate button will be disabled if the campaign is closed.
• If the donor clicks the donate button while he is logged in and the campaign is available to donate (open), A popup form will show on the screen, so can the donor donate.
• Donor can donate with the amount of money, food, clothes desired also inputs for adding needed information for the pickup of donated material, a description, location and deliever time for the donation that is submitted.
• If user doesn't have an account he can easily navigate to the signup page to create one.

As an Admin:

• By entering indonate, admin will be promoted with an overview page where statistics about the top most generous donors donated to campaigns, top campaigns that the most donation and its to its target.
• Campaigns page where an admin can view all campaigns information or adding, editing, deleting a campaign or choosing beneficiary families by closing the campaign.
• An admin can also view donors information including donations collected by the donor and how to contact the donor, another tools where an admin can add, edit or delete a donor.
• Also an admin can either add, edit or delete a family and view information about families and donations recieved for this family and campaigns included for a specific family.
• lastly admin can view all comments and feedback submitted by users using the contact us form in the landing page.

back to top

User Stories 📔

As a Donor I can:

• Access my account either by signing in or registering to the website.
• Navigate easily between sections and pages.
• View the latest campaigns and all dontaion stats.
• Submit an issue using contact us form.
• View all website campaigns and filter or search by my own need.
• Access any campaign page and view full description of the campaign, the donations sumbitted for this campaign and beneficiary families included in this campaign.
• Submit a donation with the amount i desire either food or money or clothes.

As an Admin I can:

• Access my account either by signing in or registering to the website.
• View overview page with all statistics including families, campaigns, all donations.
• View the all campaigns with its target donations and current donations.
• Edit, delete close campaign and choose beneficiary families before closing a campaign.
• Edit, delete and view all donors information that are both donated and didn't donate and campaigns donated to.
• Edit, delete and view all families in need, view assigned campaign for a specific family also view money, food and clothes donations recevied for that family.
• View all issues and feedback submitted by website applicants.

back to top

Set up application locally: 💻

1. Clone the repo

   git clone https://github.com/GSG-G11/Indonate.git
   

2. Install NPM packages

   • dir /indonate

     npm install
     

   • dir /indonate/client

     cd client 
     npm install
     

3. Enter your Database connection and Secret key in .env file

    DB_URL=postgres:<user_name>:<password>@localhost:5432/<db_name>
    SECRET=<secret key for access token>

back to top

Contributers: 👥

Team Leader

• Raghad-Mezied

Team Members

• Hani Olwan
• Mohammed Hamada
• Deena Alghazali
• Farah Shaqoura

Stretch Goals: 🎯

• Chat
• Google OAuth
• Map

back to top