Skip to content
This repository has been archived by the owner on Oct 2, 2022. It is now read-only.

zenith110/pubsub_api

Repository files navigation

Image

Table of Contents

  1. Credits
  2. Goals
  3. How to use
    1. All Button
    2. On Sale Button
    3. Not On Sale Button
    4. Newsletter
  4. Playground
  5. Discord-Bot

Credits

Without these people's support, Pubsub-api would not be functioning the way it is today!

CallumCoy - Help with making JSON data easy to read, various bug fixes.

i7Solar - Shifting the web scraping over to using pure requests.

Sfabura - Design of the website and ux.

Goals

To deliver users the latest deals on Publix subs, via email or through the api via various mediums such as: Discord bots, Slack Bots, or other functionality

How to use

The site is hosted at https://pubsub-api.dev and has a grid based system in displaying subs. There are three buttons and they all control the filtering system for deciding which subs you want.

All Button

All displays both not on sale and sale subs.

On Sale Button

On Sale displays subs currently on sale.

Not On Sale Button

Not On Sale displays subs that are currently not on sale.

Newsletter

By clicking the email icon near the footer, user may sign up to recieve emails from pubsub-api.dev in regards to selected subs. Options may be changed by returning to the newsletter icon and changing the options, only the email is required while the rest can be changed to what the user pleases.

Playground

To get a feel for how the API responds and the various endpoints, you may test them on https://api.pubsub-api.dev/apidocs/. These various functions are what the API uses and responds with. This is very handy for using in regards to requesting data via endpoints.

Discord-Bot

If you're wanting to utalize the API but prefer not to program it yourself, we also offer our own in house discord bot to use as well! Discordbot, we also have a discord server available here as well! Discord Server