An open API service indexing awesome lists of open source software.

https://github.com/rawenchilada/bingebuddy

A webpage for browsing and keeping track of your tv shows.
https://github.com/rawenchilada/bingebuddy

angular expressjs fullstack media service

Last synced: 2 months ago
JSON representation

A webpage for browsing and keeping track of your tv shows.

Awesome Lists containing this project

README

          

# BingeBuddy

BingeBuddy is a web application that allows you to keep track of your favorite TV shows and movies. It is built using Angular and Express.

The backend is a proxy server that forwards requests to the TMDB API and keeps track of the user's watchlist and watched items. This backend exists in order to avoid having to expose the TMDB API key to the frontend and to keep your viewing data completely private.

## Backend Installation

### Configuration

The backend is configured using a config.json file, with the following parameters:

```json
{
"apiKey":"tmdb_v3_api_key_here",
"password":"your_password_here",
"sourceUrl":"http://my_backend_host:8080",
"targetUrl":"https://api.themoviedb.org/3",
"port": 8080
}
```

### Running the backend

To run the backend, simply run the following command:

```bash
cd backend;
npm install;
npm run start
```

## Frontend Installation

### Configuration

The frontend is configured using an environment.ts file in frontend/environment.ts with the following content:

```typescript
export const environment = {
apiUrl: 'http://my_backend_host:8080',
};
```

### Running the frontend

To run the frontend, simply run the following command:

```bash
cd frontend;
npm install;
npm run build;
serve -s dist/binge-buddy -l 8081
```

Using serve is optional, you can also use any other webserver to serve the files in the dist/binge-buddy folder.

## Screenshots

Login screen:
![Login screen](docs/login.png)

Browse shows:
![Browse shows](docs/browse.png)

Show details:
![Show details](docs/details.png)

## Credits
|||
|---|---|
|![TMDB](frontend/src/assets/tmdb-logo.svg)|This project uses the TMDB API to retrieve information about movies and TV shows. |
|![JustWatch](frontend/src/assets/JustWatch-logo.png)|This project uses the JustWatch API to retrieve information about where to watch movies and TV shows. |