Project Name

DonateAndHelp

Table of Contents

1. Project description
2. Motivation
3. Project Team
4. Frameworks used
   1. Frondend
   2. Backend
   3. Testing
   4. API
   5. Deployment
5. Development
   1. Installation
   2. Running Application
6. Features
7. Running tests
   1. React JS
   2. Backend
8. Production
9. Project repo on GitHub
10. Contact details

Project description

Our project name is "DonateAndHelp" which is a platform on a website and mobile application that connects beneficiaries with donors in order to receive money donations from donors, in a response to the fundraising campaigns uploaded by beneficiaries on the platform. In addition, donors can upload their items for donations they want to donate for any beneficiaries.

Motivation

We founded "DonateAndHelp" to connect beneficiaries with donors in Jordan and MENA region, as we have observed an alarming gap in the online donation software market in the region, so we set out to create the simplest solution around here. "DonateAndHelp" can build bridges between beneficiaries and donors, where beneficiaries can receive money donations online for their fundraising campaigns, as well as donors can upload their items for donations for any beneficiaries.

Project Team

• Qays Trad
• Yussur Alani
• Mohammad Duraidi
• Mais Muhtaseb

Frameworks used

Frondend

• React JS for web development
• React Native for mobile development

Backend

• Node/Express
• MongoDB

Testing

• Mocha
• Chai

API

• Nexmo (sending SMS)

Deployment

• Heroku

Development

Installation

• Install React Native for frontend mobile development

   npm install -g create-react-native-app
   create-react-native-app DonateAndHelp
   cd DonateAndHelp
   npm start

• Install Express Node.js framework: npm install express
• Install MongoDB: npm install mongoose

Running Application

• Frontend for the website Go to the project repo and run npm run react

• Frontend for the mobile app Go to reactNative folder in the project repo and run npm run start

• MongoDB Go to the project repo and run mongod

• Node.js/Express server Go to the project repo and run npm run server

Features

• User Authentication
• Create fundraising campaigns by beneficiaries and donation campaigns by donors
• Search for fundraising campaigns by donors and donation campaigns by beneficiaries
• Exchange messages between donors and beneficiaries
• Add and edit user profile
• Upload and view user images on web application
• View activities in user profile
• View the fundraising campaigns created by beneficiaries based on a category in the donor home page
• Contact project team through sending messages

Running tests

• React JS:
  npm run test-react
• Backend:
  npm run test

Production

• See our website here
• See our project demo here

Project repo on GitHub

• See our project repo here

Contact details

• Qays Trad
• Yussur Alani
• Mohammad Duraidi
• Mais Muhtaseb