PebbleWork

Pebblework brings together people who wants to make a change
in the world. It connects organizations that want to conduct events
with donors and volunteers with a purpose of creating
a meaningful impact.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About the Project
   • Project Features
   • Tools and Technologies
   • Design Diagrams
     • System Architecture Diagram
     • Database Schema Design
2. Installation Guide
   • Prerequisites
   • Installation
3. Linked Frontend Application
4. Contributing Guide
5. Contributors
6. License
7. Acknowledgments
8. Contact

About the Project

The ideology behind Pebblework is creating significant outcome by gathering community members together to be a part of collective effort.

This platform is for everyone who wants to bring something big to life by giving their time, energy or financial support whether they are an organization,a volunteer or a donor.

On Pebblework, you can create an event and find volunteers that want to be a part of it or you can search for events to contribute your local community by searching categories that fit your interests based on location and time. If you don’t have time or energy but still want to support a fund you can take a look at the target and remaining funds of the funds and donate anonymously. Pebblework is a great platform for creating solid impact while feeling the warmth of being one with your community!

Project Features

• CRUD Events
• CRUD Funds
• Sign in/up/out
• Volunteer for an Event
• Invite Volunteers to an Event
• Donate to a Fund
• Create a user or an organization account
• Edit user or organization account
• Rate an organization
• Subscribe or unsubscribe to an organization or a user
• Get public profile of a user or organization
• Sign in/up with Google
• Sign in/up with Twitter

Tools and Technologies

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

Design Diagrams

System Architecture Diagram

In this diagram, you can see the various components of our REST API, such as API routers, services, and utils, as well as our MongoDB database and how it is integrated with the rest of the project.

Database Schema Design

This is known as a UML diagram, and it shows the collections used in the database, their properties, the relationships between them, and the functionality that each collection (class) can have. We chose this diagram because it contains a lot of information and will help us organize our thoughts as we implement our application.

Installation Guide

Prerequisites

1. Node.js
2. Yarn
3. Git

Installation

1. Clone the repo

   git clone https://github.com/RCDD-202203-TUR-BEW/backend-capstone-turkey-pebble-work.git

2. Navigate to the project folder

   cd backend-capstone-turkey-pebble-work

3. Install dependencies

   yarn

4. Run the project

   yarn start

5. Run checks and tests

   yarn test

Documentation

Explore our interactive documentation API here.

Linked Frontend Application

Contributing Guide

Contributions are what make the open source community such a wonderful place to learn, be motivated, and create. Your contributions are deeply appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contributors

Lead Engineer	Junior Engineer	Junior Engineer	Junior Engineer	Junior Engineer	Junior Engineer
Halit Batur	Lara Gurol	Mehmet Baki	Muhammed Şihebi	Rama Alshaban	Sara Hamoud

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

• 
• 

Contact

PebbleWork Team

Email: [email protected]