README.md

Helpful

Why?

Sometimes finding volunteer work is the hardest part. Helpful aims to bridge the gap between those who need, and those who can give. Connect with Organizations and see events happening in your community.

What?

Helpful brings community organizations and volunteers together. If you want to make a difference in your community, you can find groups and events that would love to get your help. If you are an organization in need of volunteers, you can post your organization's profile and publicize your events here.

Screenshots

Landing page

Dashboard

Public Event

MVP (v.1.0.0)

Create an Organization: Users can create Volunteer Organizations
Create Events within an Organization: Organizations can create unlimited events in which users can attend
Rate your favorite Events: Persistent storage of all events
View relevant opportunities by proximity: Integration with Google Maps API for proximity based search

V2 feature list

Export RSVP Data to CSV
Leave comments on organization page
Gamification: Add kudos, karma or some awards system to give to users. Shareable badges.
User availability calendar and active flag
Heatmap based on attendee density
Frequent User Data
Additional styling/accessibility

Tech Stack

Front End:

• React (Hooks)
• React Google Maps
• Vanilla CSS (No framework)

Back End:

• Node/Express
• MongoDB/Mongoose
• JWT/bCrypt

Testing:

• Mocha/Chai
• Jest/Enzyme

Links

• AGILE SCRUM Board
• Twitter
• ProductHunt
• Deployed Client

Team

• Bryan Johnson - Marketing Lead
• Michael McKay - Project Manager
• Codey Worley - QA Lead
• Barrett Carpenter - Product Manager
• Joaquin Fox - Design Lead

API

/api
├── /users
│   └── GET
│       └── /
│   └── POST
│       └── /register
├── /auth
│   └── POST
│       ├── /login
│       ├── /refresh
├── /org
│   └── GET
│       ├── /all
│       ├── /location/:range/:lat/:lng
│       ├── /:id
│   └── POST
│       └── /
│   └── PUT
│       ├── /
│   └── DELETE
│       ├── /
├── /event
│   └── GET
│       ├── /all
│       ├── /location/:range/:lat/:lng
│       ├── /:id
│       ├── /org/:id
│   └── POST
│       └── /
│   └── PUT
│       └── /
│   └── DELETE
│       └── /
├── /follow
│   └── GET
│       ├── /all
│       ├── /user
│       ├── /following/:id
│       ├── /org/:id
│       ├── /:id
│   └── POST
│       └── /
│   └── PUT
│       └── /
│   └── DELETE
│       └── /
├── /rsvp
│   └── GET
│       ├── /all
│       ├── /user
│       ├── /event/:eventId
│       ├── /:id
│       ├── /specific/:eventId
│   └── POST
│       └── /
│   └── PUT
│       └── /
│   └── DELETE
│       ├── /
│       ├── /user
├── /meetup
│   └── GET
│       ├── /all
│       ├── /owner
│       ├── /:id
│   └── POST
│       └── /
│   └── PUT
│       └── /
│   └── DELETE
│       └── /
├── /rsvpmeetup
│   └── GET
│       ├── /all
│       ├── /user
│       ├── /org/:id
│       ├── /:id
│       ├── /meetup/:id
│   └── POST
│       └── /
│   └── PUT
│       └── /
│   └── DELETE
│       └── /
├── /role
│   └── GET
│       ├── /all
│       ├── /user
│       ├── /org/:id
│       ├── /:id
│   └── POST
│       └── /
│   └── PUT
│       └── /
│   └── DELETE
│       └── /
├── /comments
│   └── GET
│       ├── /
│       ├── /event/:eventId
│       ├── /user/all
│   └── POST
│       └── /
│   └── PUT
│       └── /
│   └── DELETE
│       └── /
├── /orgrating
│   └── GET
│       ├── /
│       ├── /org/:orgId
│       ├── /user/:id
│       ├── /user/all
│   └── POST
│       └── /
│   └── PUT
│       └── /
│   └── DELETE
│       └── /