Skip to content

Latest commit

 

History

History
122 lines (82 loc) · 2.46 KB

README.md

File metadata and controls

122 lines (82 loc) · 2.46 KB
Raw

Hilful-Fujul Charity Project

Hilf al-Fudul Charity Project

This is a MEERN (MongoDB, Express.js, React.js, Node.js) stack project aimed at creating a charity platform. Users can view and donate to various causes listed on the platform.

Table of Contents

Features

  • User authentication and authorization
  • Browse and search for different charity causes
  • Donate to causes
  • Admin panel to manage causes

Technologies Used

  • HTML, CSS, JavaScript
  • React.js
  • Tailwind CSS
  • Axios
  • Tanstack Query
  • Node.js
  • Express.js
  • MongoDB

Installation

Prerequisites

  • Node.js installed on your machine
  • MongoDB instance running

Frontend

Clone the frontend repository:

git clone https://github.com/naymHdev/Hilful-Fujul-Client.git

Navigate to the project directory:

cd Hilful-Fujul-Client

Install dependencies using Yarn:

yarn install

Create a .env file in the root directory and add the following variables:

REACT_APP_API_BASE_URL= https://hilf-al-fudul-server.vercel.app

Start the development server:

yarn start

Access the frontend application at

http://localhost:5173

Backend Source Code

Clone the backend repository:

git clone https://github.com/naymHdev/Hilf-Al-Fudul-Server

Navigate to the backend project directory:

cd your-backend-directory

Install dependencies:

yarn install

Create a .env file in the root directory and add the following variables:

PORT = process.env.PORT || 8000;
MONGODB_URI= "mongodb+srv://HilfalFudul:pvNEyRc1Df5vdro8@firstpractice.poejscf.mongodb.net/?retryWrites=true&w=majority";

Start the backend server:

yarn start

Live Demo

You can access the live demo of this project here. here

License

This project is licensed under the MIT License - see the LICENSE file for details.

Make sure to replace the placeholder URLs and directory names with your actual project details. This README.md file should provide comprehensive instructions for setting up both the frontend and backend of your MEERN stack project.