/HelperBirdy

HelperBirdy is where passion meets purpose! Our platform connects volunteers with organizations and causes in need, empowering individuals to make a meaningful impact with their skills and expertise.

Primary LanguageJavaScript

Connect & Help - A Platform for Mutual Support

Tagline

"Connecting people to help each other, one post at a time."

Overview

Connect & Help is a social platform where individuals can share their needs and receive help from others. Users can create posts describing their needs, and others can comment with offers of help. This platform aims to foster a sense of community and mutual support.

Features

  • User Registration: Users can create an account and fill out a profile with their interests, skills, and availability.
  • Post Creation: Users can create posts describing their needs, including details such as:
    • Title: A brief summary of the need.
    • Description: A detailed description of the need.
    • Categories: Users can select relevant categories (e.g., errands, household chores, emotional support).
  • Commenting System: Users can comment on posts with offers of help, including:
    • A brief description of how they can help.
    • Their availability (e.g., specific dates and times).
  • Filtering and Sorting: Users can filter and sort posts by categories, dates, and locations to find relevant opportunities to help.
  • Connection System: Users can connect with each other through private messaging or video calls to discuss their needs and offers of help in more detail.

MVP Requirements

  • User registration and login functionality.
  • Post creation and editing functionality.
  • Commenting system for users to offer help.
  • Basic filtering and sorting functionality for posts.
  • Private messaging or video call functionality for connecting users.

Technical Requirements

  • Front-end: Built with React.js and Vite.
  • Back-end: Node.js with Express.js for creating a RESTful API.
  • Database: MongoDB Atlas for storing user data and posts.
  • Security: Implement secure password hashing and JWT authentication to protect user data.

Getting Started

  1. Clone the repository: git clone https://github.com/H-Asmaa/volenteer
  2. Navigate to the backend folder: cd volenteer/backend
  3. Install backend dependencies: npm install
  4. Run the backend: node server.js
  5. Navigate to the frontend folder: cd ../frontend
  6. Install frontend dependencies: npm install
  7. Run the frontend: npm run dev
  8. Access the application: http://localhost:5000

Contributing

  1. Fork the repository: git fork https://github.com/H-Asmaa/volenteer
  2. Create a new branch: git checkout -b feature/new-feature
  3. Make changes and commit: git add . and git commit -m "Added new feature"
  4. Push changes: git push origin feature/new-feature
  5. Create a pull request.

License

This project is licensed under the MIT License.