Skip to content

Abdallah-Alwarawreh/Syrup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Syrup: The Open-Source Honey Alternative

Build Extension Discord

Syrup is a lightweight, open-source browser extension designed to make finding and applying the best coupons effortless. Unlike traditional tools like Honey, Syrup prioritizes transparency, user privacy, and ethical design over profit-driven motives.

Please read the privacy policy.

You can help the project financially by becoming a Patreon member here or on Ko-fi.


πŸŽ₯ Featured Video

Watch how and why Syrup was made!


🌟 Features

  • πŸ” Smart Coupon Finder: Automatically scans for and applies the best coupons during checkout.
  • 🌱 Ethical & Transparent: Open-source and free from hidden agendas or shady affiliate deals.
  • πŸ”’ Privacy-Focused: No tracking, no data harvesting just savings.

πŸ’ͺ Installing

The Syrup extension is availabe to anyone using a Chromium or Firefox-based browser with WebExtension support!

Chrome download link Firefox download link ...or manually as a .crx-file


πŸš€ Building

  1. Prerequisites:
    Node.js and npm installed for development.

  2. Download the Extension:
    Clone or download the repo:

    git clone https://github.com/Abdallah-Alwarawreh/Syrup.git
    cd Extension-React
  3. Build the Extension:
    Install dependencies and build:

    npm install
    npm run build
  4. Add to Your Browser:

    • Open your browser’s developer mode.
    • Load the dist folder as an unpacked extension.

🀝 Contributing

We welcome contributions to improve Syrup! Here’s how you can help:

  1. Fork the repository.
  2. Create a branch for your feature or bug fix:
    git checkout -b my-new-feature
  3. Commit your changes and push the branch:
    git commit -m "Add my feature"
    git push origin my-new-feature
  4. Open a Pull Request!

For major changes, please open an issue first to discuss what you’d like to contribute.

Translating

You can also contribute by helping to translate Syrup! This is done through our Crowdin instance.


πŸš€ Backend / API

⚠️ Work in Progress! Feel free to contribute and shape the future of Syrup!

Exchangeable Backend System

The backend system is designed to be fully exchangeable! You can:

  • 🏠 Host existing backends yourself
  • πŸ› οΈ Write your own implementation
  • πŸ”Œ Use different providers
  • βš™οΈ Configure everything in the extension settings

API Standard

The backend follows the Syrup API Standard (SAS). Check out our backend documentation for all the details! Found something that could be improved? Create an issue - we'd love to hear your thoughts!

Current Implementation

The current backend is maintained by @ImGajeed76. Check out the implementation here: discountdb-api

Got questions? Feel free to:

  • πŸ’¬ Contact @ImGajeed76 on Discord
  • πŸ“ Open an issue in the discountdb-api repo
  • 🀝 Contribute to the project (and maybe leave a star πŸ˜‰)

πŸ“š Tech Stack

Techstack


❀️ Acknowledgements

Special thanks to the amazing people who made Syrup possible:

  • Nufshi and skyerush for their support in creating the video.
  • Taco for incredible emotional support.
  • And for our lovely contributors:
    • @abstra208 - UI, Safari Extension, Translation and Bug Fixes.
    • @mvlwarekekw - Translation and Bug Fixes.
    • @1A3Dev - UI, Safari Extension and Bug Fixes.
    • @cranberry3148 - Auto Apply Coupons and Bug Fixes.
    • @ImGajeed76 - API and Endpoints and his backend (go star) we use
    • @hammerill - Github Build Script.
    • @chipseater - Redirection Handler in Website.
    • @JxxIT - Bug Fixes.
    • And to all other individuals who edited the README.

πŸ“„ License

Syrup is licensed under the MIT License. Feel free to use, modify, and distribute this project.


πŸ—¨οΈ Join the Community

Have questions, ideas, or just want to connect? Join our Discord Community!