Showbunny 🐰

Your cozy burrow for discovering and tracking movies & TV shows!

Visit the Warren 🐾 (Prior Version) — Report Bug 🐛 — Request Feature 🐰

Table Of Contents

• Table Of Contents
• About The Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
  • Environment variables
• Usage
• Roadmap
• Contributing
  • Creating A Pull Request
  • Joining the Community
• License
• Authors
• Acknowledgements

About The Project

There are many great streaming sites on the web; however, most of them lacked features we wished were included. We wanted to create a site so amazing — so burrow-worthy — that it'll be the last one you ever need. 🐰

Welcome to Showbunny, your cozy warren for all things film and television.

Built With

This project was built using vanilla HTML, CSS and JavaScript.

• H5BP
• Vite
• Web Components
• Design Concept
• TMDB

Getting Started

To hop into this project locally, follow the steps below.

Prerequisites

You will need the following installed on your machine:

• Node.js
• Git

Installation

First, clone the repository:

git clone https://github.com/macjabeth/showbunny.git

Then install the NPM packages:

npm install

Environment variables

Create a .env file in the project root (or .env.local) and define your TMDB API key:

VITE_TMDB_KEY=your_tmdb_api_key_here

Usage

The default npm scripts are as follows:

{
  "scripts": {
    "dev": "vite",
    "build": "vite build",
    "serve": "vite preview",
    "format": "biome format --write .",
    "lint": "biome lint .",
    "check": "biome check --write ."
  }
}

To start the dev server, type npm run dev into the terminal.

Roadmap

See the open issues for a 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 (and will get you added to the acknowledgements section).

• If you have suggestions for adding or removing features, feel free to open an issue to discuss it, or directly create a pull request after making any necessary changes.
• Create individual PRs for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea.

Creating A Pull Request

1. Fork the Project
2. Create your GitFlow Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'Add some amazing-feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Joining the Community

We have a community on Discord to discuss Showbunny and other topics. Hop on in! 🐾

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• macjabeth - a software engineer passionate about learning new technologies and teaching others to be better developers
• BabyMaybe - a feral neighbourhood cat

Acknowledgements

• dreaminfo
• shad-k
• crownedpigeon
• bennetthanna
• itsbmed
• UpGrowt
• ARJITMALIK
• Bassadin