Giter Club home page Giter Club logo

pubsub_api's Introduction

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

pubsub_api's People

Contributors

zenith110 avatar sfabara avatar callumcoy avatar i7solar avatar

Stargazers

Eric avatar  avatar Ashwin Mathi avatar  avatar  avatar  avatar Suneet Tipirneni avatar Simon Weizman avatar  avatar

Watchers

 avatar

pubsub_api's Issues

Unit tests for v1

Create unit tests that mock the various functionalities for v1(python) version of the api.

Graphql endpoint

Allow the usage of graphql endpoint to be used to do a singular fetch of a sub opposed to going through multiple channels. v1 and v2 will be kept concurrently.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.