Blue Dog API

Blue Dog API

Bluey API with a styled front end and games for my daughter to play
Explore the docs »

View Demo · Report Bug · Request Feature

Bluey API - Available on RapidAPI

I'm excited to share that my Bluey-themed API is now live on RapidAPI! 🎉 This API is perfect for developers looking to create Bluey-themed apps, games, or anything related to the Bluey TV show.

🔵 Explore the API and start building today:
Bluey API on RapidAPI

Table of Contents

• About The Project
  • Built With
• Getting Started
  • Installation
• Usage
• Routes
• Roadmap
• Contributing
• License
• Contact
• Acknowledgments
• Resources Used
• Time Bluey Watched

About The Project

This project was built using the MERN stack and Apollo/GraphQL. It contains mutable data for user integration, styled front end, and games. It uses Materialize for a CSS framework. It uses Mongoose as an ORM. It uses Reder for deployment. It also makes use of packages JWT and Bcrypt.

Built With

Technologies used:

Getting Started

Installation

🚀 Installation

Clone the repository

cd blue-dog-api

Add a .env file to the /server/src/ folder with the following variables:

MONGODB_URI=your_mongodb_connection_string
JWT_SECRET_KEY=your_jwt_secret_key

Install dependencies

npm i
npm install

Build the project

npm build

Start the development server

npm run dev

Usage

Once the app is running, you can navigate to the front end and interact with the Bluey API or play the built-in games.

Routes

Character Routes

• GET /api/characters - Get all characters
• GET /api/characters/:id - Get a character by ID
• POST /api/characters - Create a new character (protected)
• PUT /api/characters/:id - Update a character (protected)
• DELETE /api/characters/:id - Delete a character (protected)

Episode Routes

• GET /api/episodes - Get all episodes
• GET /api/episodes/:id - Get an episode by ID
• POST /api/episodes - Create an episode (protected)
• PUT /api/episodes/:id - Update an episode (protected)
• DELETE /api/episodes/:id - Delete an episode (protected)

Location Routes

• GET /api/locations - Get all locations
• GET /api/locations/:id - Get a location by ID

Book Routes

• GET /api/books - Get all books

User/Auth Routes

• POST /api/users/signup - Sign up
• POST /api/users/login - Log in
• GET /api/users/me - Get current user info (JWT required)

Roadmap

• Episode Names
• Episode Descriptions
• Episode Lengths
• Episode Characters
• Quotes
• Character Names
• Character Descriptions
• Character Images
• Locations
• Location Images
• Episode Images
• Filter by Australian Content
• Books
• Toys
• Garden gnomes
• Long Dog
• Songs
• Trivia- ask Trivia Bros for collab

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to 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

Don't forget to give the project a star! Thanks again!

License

This project is licensed under the MIT license. See LICENSE.txt for more information.

Contact

Mary Elenius - mary.panda.jackson@gmail.com
Deployment Link: https://blue-dog-api.onrender.com/ Project Link: https://github.com/404pandas/blue-dog-api
Portfolio: Mary Elenius

Acknowledgments

• Yennefer — the mighty inspiration
• Friends and family for support
• RapidAPI Guide
• RapidAPI Listing
• GitHub
• Render

Resources Used

• https://www.bluey.tv/watch/
• https://blueypedia.fandom.com/wiki/Bluey_(TV_series)

Time Bluey Watched

Current count: 167 full rewatch sessions