README.md

Paying It Forward

Reduce the inequality in Turkish education system
by enabling donation for the students who couldn't afford
basic education needs
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • Built With
   • Screenshots
2. Getting Started
   • Prerequisites
   • Installation
3. Team
4. Documentation
5. Contributing
6. License
7. Acknowledgments

About The Project

Paying it forward will help to reduce inequality in the education system in Turkey. In our current society, unfortunately some children or families couldn't afford basic needs such as books, stationery, etc. The platform aims to meet those needs via donation or enabling item sharing such as sending non-used books. The students also can request items they need and let the others know about this. The platform will also send a newsletter email to the registered users every week.

(back to top)

Features

• List items and users
• CRUD operations for items
• CRUD operations for users
• Rating users
• Filter items by their category
• Register/Login
  • Allow Google, Classic
• Newsletter subscription
• Middleware for item owners

(back to top)

Built With

• Node.js
• Express.js
• MongoDB
• Nodemailer
• ESLint
• Husky
• AWS
• Swagger
• Jest

(back to top)

Screenshots

Database Design

System Architecture Design

Homepage

Getting Started

Prerequisites

• yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/RCDD-202110-TUR-BEW/backend-capstone-turkey-paying-it-forward.git

2. Navigate to the project folder

   cd backend-capstone-turkey-paying-it-forward

3. Install dependencies

   yarn

4. Run the project

   yarn start

5. Run checks and tests

   yarn test

(back to top)

Website and Documentation

Check out our website. Explore our interactive API documentation here.

(back to top)

Team

@mkkasem	@mehmetfatiherdem	@AmmarBaki2	@Peri7at	@Ammar-64	@Shrreya

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly 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

License

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

Acknowledgements

• 
• 
• 

(back to top)