Let's Share API

A sharing and Posting API

powered by

🔬 Description

"Let's Share" encourages people who live in the same region to share their extra electronics, clothes, furniture, etc.
Let's Share is an API that allows people to post donation and request posts where one order request can be approved to take the product.

⚙️ Demo

Server link: Let's Share API

🧱 Features

• Signin/Signup authentication
• 3rd Party authentication (Google, Facebook)
• List products
• CRUD operations for products
• CRUD operations for users
• Donate products
• Request products
• Filter products by category
• Search products
• Middleware for validation and error handling

🦾 Team

Lead board

• 🧔🏻 Halit Batur
• 🧔🏻 Muslim Omar

Developers

• 👩🏻 Noor Awied
• 👩🏻‍🦱 Ezgi Okur
• 👩🏻‍🦱 Nilay Aydin
• 👨🏻 Adnan Khaldar
• 🧔🏻 Amjad Khatib

🛠 Tech

Let's Share uses a number of open source modules to work properly:

• ExpressJS - a fast Node.js network app framework.
• Node.js - an evented I/O for the backend.
• VSCode - an awesome web-based text editor.
• Heroku - a cloud platform as a service.
• Nodemailer - a module for Node.js applications to allow easy email sending.
• Nodemon - automatically restarting the node application when file changes in the directory are detected.
• MongoDB - a source-available cross-platform document-oriented database program.
• PassportJS - an authentication middleware for Node.js.
• Swagger - build, document, test and consume RESTful web services.
• JWT - a compact URL-safe means of representing claims to be transferred between two parties.
• Chai - BDD / TDD assertion library for Node.js.

🌆 Screenshots

System Structure

Database Schema

🕹 Installation

Let's Share requires Node.js v10+ to run.

Install the dependencies and devDependencies and start the server:

cd backend-capstone-turkey-lets-share
yarn install

For production environments:

yarn install --production
NODE_ENV=production

Starting the server

To start with node:

yarn start

To start with nodemon:

yarn dev

📦 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

MIT

Free Software, Hell Yeah!

📬 Contact

[email protected]