Skip to content

zachspiel/bobs-burgers-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

90 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

License: MIT

Banner Image

The Bob's Burgers API

The Bob's Burgers API is a REST/GraphQL API based on the television show Bob's Burgers. The Bob's Burgers API contains data for hundreds of characters, episodes, running gags and images from the show.

Getting Started

Configuration

This project requires the variable DATABASE_URL to be added to a .env file. The variable PORT can also be defined, the default is 5000.

The production environment requires an additional variable SECRET, this is used by Express Visitor Counter for tracking unique visitors.

โ— IMPORTANT: The database URL must match the format mongodb+srv://{username}:{password}@{cluster}/{database}

Installation

Install the required dependencies with Yarn.

yarn install

Start the Server

yarn start

Rate Limiting

โ— IMPORTANT: There is a rate limit set to 200 requests every five minutes. If this value is too low for your use case, please feel free to raise an issue in this repo.

API Documentation

Checkout out the Bob's Burgers API Website to learn more about the API.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT