Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LuisAlejandro/movie-box
📺 Get your last watched movies and shows (+more) report from trakt.tv in a GitHub Gist.
https://github.com/LuisAlejandro/movie-box
gist movie-box trakt trakt-api trakt-tv watched-movies
Last synced: about 1 month ago
JSON representation
📺 Get your last watched movies and shows (+more) report from trakt.tv in a GitHub Gist.
- Host: GitHub
- URL: https://github.com/LuisAlejandro/movie-box
- Owner: LuisAlejandro
- License: gpl-3.0
- Created: 2020-04-04T17:04:23.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-30T01:19:10.000Z (2 months ago)
- Last Synced: 2024-10-02T01:22:21.335Z (2 months ago)
- Topics: gist, movie-box, trakt, trakt-api, trakt-tv, watched-movies
- Language: JavaScript
- Homepage:
- Size: 848 KB
- Stars: 22
- Watchers: 3
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
- awesome-pinned-gists - movie-box - Update a pinned gist to contain your media center stats from Trakt.tv. (External Services)
README
Movie Box
Update a gist to contain your recently watched movies from trakt.tv
---
> 📌✨ For more pinned-gist projects like this one, check out: https://github.com/matchai/awesome-pinned-gists
## ✨ Inspiration
This code was heavily inspired by [@jacc's music-box](https://github.com/jacc/music-box).
## 🎒 Prep Work
1. Create a new public GitHub Gist (https://gist.github.com/).
2. Create a token with the `gist` scope and copy it. (https://github.com/settings/tokens/new).
3. Create a Trakt.tv Application and copy the `API token` (https://trakt.tv/oauth/applications/new).
## 🖥 Project Setup
1. Fork this repo.
2. Go to your fork's `Settings` > `Secrets` > `Add a new secret` for each environment secret (below).
3. Activate github workflows on `Actions` > `I understand my workflows, go ahead and run them`.
4. Star your own fork to trigger the initial build. Then the gist will update hourly. You can then go to your profile and pin the gist.
## 🤫 Environment Secrets
Set the following environment secrets on `github.com//movie-box` > `Settings` > `Secrets`:
- **GIST_ID:** The ID portion from your gist url `https://gist.github.com//`**``**.
- **GH_TOKEN:** The GitHub token generated above.
- **TRAKT_ID:** The Client ID you got from creating a Trakt.tv app.
- **TRAKT_USERNAME:** Your Trakt.tv username.
- **MOVIE_BOX_MODE:** Select the box mode from three options: `movies`, `shows` and `stats`.
## 🕵🏾 Hacking suggestions
- You can test the script locally with Docker Compose:
* Install [Docker Community Edition](https://docs.docker.com/install/#supported-platforms) according with your operating system
* Install [Docker Compose](https://docs.docker.com/compose/install/) according with your operating system.
- [Linux](https://docs.docker.com/compose/install/#install-compose-on-linux-systems)
- [Mac](https://docs.docker.com/compose/install/#install-compose-on-macos)
- [Windows](https://docs.docker.com/compose/install/#install-compose-on-windows-desktop-systems)
* Install a git client.
* Clone your fork of the repository into your local computer.
* Open a terminal and navigate to the newly created folder.
* Change to the `develop` branch.
git checkout develop
* Create a `.env` file with the content of the environment secrets as variables, like this (with real values):
GIST_ID=xxxx
GH_TOKEN=xxxx
TRAKT_ID=xxxx
TRAKT_USERNAME=xxxx
MOVIE_BOX_MODE=xxxx
* Execute the following command to create the docker image (first time only):
make image
* Execute the following command to install node dependencies:
make dependencies
* You can execute the update script with this command:
make update
* Or, alternatively, open a console where you can manually execute the script and debug any errors:
make console
node index.js
* You can stop the docker container with:
make stop
* Or, destroy it completely:
make destroy
## Made with :heart: and :hamburger:
> Web [luisalejandro.org](http://luisalejandro.org/) · GitHub [@LuisAlejandro](https://github.com/LuisAlejandro) · Twitter [@LuisAlejandro](https://twitter.com/LuisAlejandro)