Reach

Reach out for a better future

Table of Contents

1. About the Project
   • Features
   • Built With
   • Demo Links
   • Screenshots
2. Getting Started
   • Prerequisites
   • Installation
3. Team
4. Contributing
5. License
6. Contact
7. Acknowledgements

About the Project

Reach is a website that connects between volunteer teachers and NGOs concerned with refugee kids around the world.

The aim of the website is to provide these kids the opportunity to develop essential skills to thrive and have a better future.

The website is intended for volunteer teachers and NGOs.

On this website, you can find a platform for both volunteers and NGOs to sign in and post their own profiles or announce educational events.

Features

• List events
• List NGOs
• List Volunteers
• CRUD operations for events
• CRUD operations for NGOs
• CRUD operations for volunteers
• Filter users by type
• Filter events by tags
• Apply events
• Approve / decline volunteers
• Register/Login
  • Allow Google, Classic
• Middleware for NGOs, volunteers
• Contact us
• Subscribe for newsletter

Built With

• 
• 
• 

Demo

• Server (backend) link:

Screenshots

Database Diagram

System Design Flowchart

OpenAPI Docs

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

• git

if (you have brew installed){
  use this command => 'brew install git'
  } else {
    download the installer from the offical website => https://git-scm.com/downloads
  }

• node

if (you have brew installed){
  use this command => 'brew install node'
  } else {
    download the installer from the offical website => https://nodejs.org/en/
  }

What is brew? (See: Homebrew Package Manager)

Installation

 main branch for server side (node)

1. Clone the app

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

2. Install npm packages on both branches

 cd backend-capstone-turkey-teach-kids

 on main branch
 'yarn / npm i'

3. Create environment variables

 if(you will serve on localhost){
  on main directory create a copy of .env.example and rename to .env file
  then change the constants to your own env strings
  ...
  SECRET_KEY: 'secret'
  ...
 } else if (you will use some SaaS hosting services like heroku, netliy etc){
  use process.ENV configuration depends on your server
 }

4. You are good to go

 on main directory =>
 if(you need to watch changes){
  'yarn dev / npm run dev'
 }else{
   'yarn start / npm run start'
 }

Team

Meet our team members through their Github profiles

@muslimomar	@abdulhafiz96	@BerkAkipek	@dilarafirtina	@sobhan-shams	@yamanrajab90

Contributing

Contributions are always welcome!

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

License

Distributed under MIT License.

Contact

Reach Team

Email: mail{at}domain{dot}com

Acknowledgements

• 
•