Skip to content

Latest commit

 

History

History
139 lines (115 loc) · 5.2 KB

README.md

File metadata and controls

139 lines (115 loc) · 5.2 KB
Raw

AidAlley

Connecting Hearts, Coordinating Hands.

image

Inspiration

Managing volunteers and events efficiently is a challenge every community organizer faces. Yet, volunteer work is essential for community support and growth. This is why we created AidAlley.

AidAlley is a volunteer management platform designed to seamlessly connect volunteers with events. Event organizers can easily create events, while volunteers can browse and find opportunities in their area. If a volunteer finds an event they are interested in, they can register and track their participation. Organizers can manage volunteers, log hours, and ensure everyone stays informed and engaged.

Key features include viewing detailed event information, creating events, signing up for events, and more.

Table of Contents

The Premise

This project is the MVP of our Portfolio Project, concluding our Foundations Year at Alx Africa. We were able to choose who we wanted to work with and what we wanted to work on, as long as we present a working program at the end of the three weeks of development.

Blogpost

Coming Soon!!!

The Team

The project was developed by Ebube Ochemba: LinkedIn || X || Medium

Technologies

  • Python - Backend
  • Flask - The Web Development Framework
  • HTML/CSS - Web Development
  • JavaScript - Web Development
  • SQLAlchemy - Python SQL Toolkit and Object Relational Mapper
  • MySQL - Relational Database Management System
  • Gunicorn - Application Server
    • Tmux - Terminal Multiplexer
  • Nginx - Web Server
  • DigitalOcean - Platform as a Service

Architecture

Coming Soon!!!

Project Structure

AidAlley/
├── api/
│   └── ...
├── models/
│   └── ...
├── web_app/
│   ├── templates/
│   │   ├── base.html
│   │   ├── index.html
│   │   └── ...
│   ├── static/
│   │   └── ...
│   ├── views/
│   │   ├── index.py
│   │   └── ...
│   └── app.py
├── tests/
│   └── ...
├── .flaskenv
├── .gitignore
├── config.py
├── requirements.txt
├── run.py
└── README.md

Dependencies

requirements.txt - *incomplete

Installation/Configuration

Development Environment - Ubuntu 22.04.4 LTS Style guidelines: PEP 8 (version 1.7) || Betty style || semistandard

$ git clone https://github.com/Ebube-Ochemba/AidAlley.git
$ cd AidAlley
$ pip3 install virtualenv
$ virtualenv .venv
$ source .venv/bin/activate
$ pip3 install -r requirements.txt
$ cat setup_mysql_dev.sql | mysql -hlocalhost -uroot -p

Usage

$ source setup_env.sh
$ flask run

Features

  • Logged In & Logged Out Experiences
  • View Events
  • Event Creation
  • Event Management
  • Event Signup

Future Plans

  • Mobile App Development: Create a mobile application for on-the-go event management and volunteer registration.
  • Enhanced Reporting: Implement detailed analytics and reporting features for organizers to track volunteer impact.
  • Automated Notifications: Introduce automated email and SMS notifications to keep volunteers informed about upcoming events and updates.
  • Community Forum: Add a forum for volunteers and organizers to communicate, share experiences, and provide feedback.
  • Integration with Social Media: Enable easy sharing of events and volunteer achievements on social media platforms to boost community engagement.

Landing Page

Click here

Acknowledgements

All work contained in this project was completed as part of the curriculum for Alx. ALX is a leading technology training provider, built to accelerate the careers of young Africans through the technology and professional skills that enable them to thrive in the digital economy. The program prepares students for careers in the tech industry using project-based peer learning. For more information, visit Alx Africa.

Related Projects

AirBnB Clone: A simple web app made with Python, Flask, and JQuery.

Author(s) Information

AUTHORS

License

MIT License