search

Suvink / volunteer-me

A platform to publish and manage volunteering events around you.
https://www.volunteerme.lk
MIT License
12 stars 10 forks source link
firebase hacktoberfest javascript volunteering

readme

VolunteerME: All volunteering in one place!

[Vue version]() [Vue version]() Netlify Status

About

Sri Lanka is one of the best places to volunteer in the world. In fact Sri Lanka has the highest rate of volunteering in the world according to the UN Volunteers.

Sri Lanka has the highest rate of volunteering in the world. Each year an average of around seven million people volunteered their time, nearly half of those aged over 15 in the country. ---CAF World Giving Index

But finding a project to volunteer is not so easy. Mainly because different hosts publish their projects on their own websites and facebook pages and they are scattered everywhere. VolunteerME is a common place to list down all the volunteering opportunities in Sri Lanka so that anyone can easily find and work in projects.

How it works

Volunteer event hosts can submit their events into VolunteerME by the submission page and upon successfull submission the host will recieve a text message. The volunteers can view the hosted events from the listings page and they can filter the nearby events by location.

Features

Set up

Requirements

Local development

After the above requirements have been met:

1. Clone this repository and cd into it

git clone https://github.com/Suvink/volunteer-me.git
cd volunteer-me


2. Install dependencies

npm install


3. Setup Firebase Project

Goto your Firebase Console and create a new project in Firebase Console. Then register a new web app. Copy the config data from the config file which will look like this.

apiKey: "firebase-api-key",
authDomain: "firebase-auth-domain",
databaseURL: "firebase-db-url",
projectId: "firebase-project-id",
storageBucket: "firebase-storage-bucket",
messagingSenderId: "firebase-messaging-id",
appId: "firebase-app-id"


4. Setup Firebase Configuration

Rename the sample.env.txt file into .env and add your previously copied Firebase configuration details there. (Replace the ###### marks with relevant details.)
Note: Leave the VUE_APP_BACKENDURL as it is for now. It will be configured later.

5. Setup Firebase Realtime Database

Goto Database section in your Firebase Console and create a Realtime Database. Import database.json file in the src folder into Firebase Database. It will create dummy data for you to test.

6. Setup the backend.
You can find the source code and setup guide for the backend here

7. Run the project 

npm run serve


Contributing

This project is open source and welcomes contributions.

Visit the project on GitHub

License

MIT

Disclaimer

No warranty expressed or implied. Software is as is.