Reda-Hammada / give-hope-fn

Give-Hope

GiveHope is an online donation platform that allows users to donate to various charities and causes around the world. Users can easily register and create a profile, browse through a list of charities and causes, and make secure donations through the platform. A web application that allows people who want to help others financially do so easily through online giving

Features

• User authentication: Users can create an account, log in, and log out.
• User profile: Users can create a profile with their personal information.
• Donation: Users can make donations to charities and causes.
• Search: Users can search for charities and causes.
• Payment: Users can make payments using Stripe.
• Responsive: The app is responsive and works on all screen sizes.

Usage

Get started by registering as an individual or organization. Give hope offers various donation causes like Climate, Education and Medical support, donation to charity organizations is also available. Under each category is a list of donation requests and description. You can either donate to a cause or charity organization or request for donation. The application has been deployed at https://give-hope-app.netlify.app . You can use the following credentials to log in and test the app:

email: <EMAIL>
password: password

You will be able to see how users are authenticated by logging into the dashboard of Netlify (the hosting platform) using the following credentials:

email: <EMAIL>
password: password

Installation & Setup

To get started with the project, follow these steps:

1. Make sure you have Node.js and npm installed on your computer.

2. Clone the repository:

   git clone https://github.com/Give-Hope-org/give-hope-fn.git

3. Navigate to the project directory:

   cd give-hope-fn

4. Install the required packages:

   npm install

5. Start the development server:

   npm run dev

6. Open the project in your text editor and start coding!

Testing

To run the tests for the frontend, use the following command:

npm run test

Contributing

Contributions are welcome! If you have any suggestions or find any bugs, please create an issue or follow these steps:

Thank you for considering contributing to this project! Contributions are highly appreciated. Please follow the guidelines below to contribute:

1. Fork the repository: Click on the "Fork" button on the repository's page to create a copy of the project in your GitHub account.

2. Clone the forked repository: On your local machine, open a terminal and use the following command to clone the repository:

   git clone https://github.com/Give-Hope-org/give-hope-fn.git

3. Navigate to the project directory: Use the cd command to move into the project's directory:

cd give-hope-fn

4. Create a new branch: Use the git checkout command to create a new branch and switch to it:

   git checkout -b <new-branch-name>

5. Make changes: Make the changes you would like to contribute to the project.
6. Commit changes: Use the git commit command to commit the changes you have made:

   git commit -m "your commit message"

7. Push changes: Use the git push command to push the changes to your remote repository:

   git push origin <your-branch-name>

8. Create a pull request: Navigate to your forked repository, and you will see a button to create a pull request. Click on the button and create a pull request to the main repository.
9. Submit Pull Request (PR): Go back to GitHub and submit a pull request with detailed description
10. Wait for code review and merge approval: Once you have submitted your pull request, a project maintainer will review your changes and either request changes or approve your pull request. Once approved, your pull request will be merged. of all your work done so far.
11. Wait for review from our team members! We will get in touch soon after we receive your pull request.
12. Once approved, merge your PR by clicking on 'Merge' button.
13. Congratulations! You've made your contribution to this project.

Prerequisites

Make sure that you meet the requirements listed here before proceeding further. If any of the requirements are not met, follow the instructions below to install the required software.

• Node.js and npm
• Git
• A text editor of your choice (VS Code is recommended)
• A web browser of your choice (Google Chrome is recommended)
• A GitHub account (for hosting the code)

Technologies Used

Vite React Tailwind CSS Plain Css

DEMO LINK:

https://give-hope-fn.vercel.app/

Screenshots