forbidenid / Volunteers_Management_System-Frontend

Volunteer Management System

Organize and manage volunteer opportunities with ease.

Welcome to the Volunteer Management System! 🌟 This project is designed to simplify the process of managing volunteers and their activities, making it easier for organizations to connect with and coordinate their volunteers. 🌟 The Inspiration

The inspiration for this project came from experiences of volunteering and working with non-profit organizations. It was cumbersome and inefficient how volunteer management could be. The goal was to create a system that would streamline the process, making it as intuitive and efficient as possible.

Live Demo

Check out our live demo here: Deployed Site

Team Members

• Dennis Muriithi
  Role: Backend Developer
  Reason: Extensive experience in Flask development and project management, ideal for overseeing backend implementation.

• Faith Kitone
  Role: Frontend Developer
  Reason: Proficient in JavaScript with experience in React.js, making her suitable for developing and designing the user interface.

Technologies

• Backend Framework: Flask
• Frontend Framework: React.js
• Database: PostgreSQL
• Authentication: Flask-Security or Flask-JWT-Extended
• Deployment: Vercel
• Email Notifications: Flask-Mail
• Database Migrations: Flask-Migrate
• API Development: Flask-RESTful
• Cross-Origin Requests: Flask-CORS
• Version Control: Git, GitHub
• UI Components: Material-UI (MUI)
• Development Environment: Visual Studio Code
• Testing: Pytest, Jest (for frontend)
• Documentation: Sphinx, Markdown

Books/Resources

• "Flask Web Development" by Miguel Grinberg
• "React - The Complete Guide" by Maximilian Schwarzmüller

Technology Trade-offs

• Backend Framework: Flask vs. Django
  Decision: Flask was chosen for its simplicity and flexibility, allowing for faster development and customization.

• Frontend Framework: React.js vs. Vue.js
  Decision: React.js was chosen for its popularity, robust ecosystem, and the team's proficiency with JavaScript.

Installation

To get started with the project, follow these steps:

1. Clone the repository:

   git clone https://github.com/yourusername/volunteer-management-system.git
   cd volunteer-management-system

2. Backend Setup:

   • Navigate to the backend directory:

     cd backend

   • Install dependencies:

     pip install -r requirements.txt

   • Set up environment variables and database configuration.
   • Run migrations:

     flask db upgrade

3. Frontend Setup:

   • Navigate to the frontend directory:

     cd frontend

   • Install dependencies:

     npm install

Usage

1. Run the backend server:

   flask run

2. Run the frontend development server:

   npm start

3. Access the application: Open http://localhost:3000 in your browser to view the application.

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

Contributing

Contributions are welcome! If you want to contribute to the project:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/your-feature

3. Make your changes and commit them:

   git commit -am 'Add new feature'

4. Push to the branch:

   git push origin feature/your-feature

5. Open a pull request.

Related Projects

• VolunteerHub
• VolunteerMatch
• Golden Volunteer App
• CiviCRM

Licensing

This project is licensed under the MIT License. See the LICENSE file for more details.

---

Feel free to adjust any links or details according to your project's specifics!

Contact

For any questions or issues, please contact Faith Kitone and Dennis Muriithi

Happy coding!