Skip to content
This repository has been archived by the owner on Sep 6, 2024. It is now read-only.

Commit

Permalink
Various changes to presentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ItsDrike
ItsDrike committed Aug 1, 2024
1 parent 10a2ad9 commit b81e8b9
Showing 1 changed file with 124 additions and 37 deletions.
161 changes: 124 additions & 37 deletions presentation/presentation.md
View file
Original file line number Diff line number Diff line change
@@ -1,101 +1,166 @@
<!--vi: tw=119
This file is supposed to be viewed using marp, which is a tool for creating Markdown based presentations.
-->

---

marp: true
footer: 'Authors: ItsDrike, Benji, Paillat-dev, Ash8121'
class: invert

---

# Name <!-- fit -->

---

<Name> is a discord bot that allows you to look for a tv show or a movie, get information about it and mark / unmark it as watched.
Allows you to get statistics about the number of episodes, shows and movies you have watched.
<Name> is a discord bot that allows you to keep track of the TV shows and movies that you have watched. You can use it
to search for and see various information about the shows/movies you're interested in, but also to mark individual
movies or show episodes as watched or favorite. The bot then allows anyone to take a look at your profile, to see what
you have watched, alongside with some neat statistics like the total number of episodes, shows and movies that you have
tracked.

---

## Data

We decided to use TheTVDB service as the base for our bot. It's a massive database of TV shows and movies with an API
that people can access for free (at least for non-profit / open-source projects). Without it, we wouldn't be able to
create this bot, so they deserve a massive thanks from us.

---

## Features
<Name> Can be used with discord application commands, and has two main commands:
- `/search` to search for a tv show or a movie

<Name> can be used with discord application commands, and has two main commands:

- `/search` to search for a TV show or a movie
- `/profile` to view your (or someone else's) profile

---

### Search

The search commands is easy to use. Just type `/search` followed by the name of the tv show or movie you want to search for, in the `query` option.
The search command is easy to use. Simply type `/search` followed by the name of the TV show or movie you want to
search for, in the `query` option.

You also have access to two more (optional) options:
- `type`: to specify if you are looking for a tv show or a movie and filter the results
- `by_id`: to search for a specific tv show or movie by its thetvdb id. When using this option, you can simply input the id in the query, and make sure to specify the type, as thetvdb ids are not unique between tv shows and movies.

- `type`: To specify if you are looking for a TV show or a movie and filter the results
- `by_id`: A boolean option that will interpret the query as a TheTVDB id. When using this option, make sure to specify
the type, as TheTVDB ids are not unique between tv shows and movies.

---

#### Search interface

![bg right 80%](img.png)
The search interface responds with a message consisting of two to three buttons, depending on the type of media you are searching for, and a dropdown menu (except if you are searching by id).
The search interface responds with a message consisting of two to three buttons, depending on the type of media you are
searching for, and a dropdown menu.

---

#### Search interface

![bg right 80%](img_1.png)
The dropdown allows you to quickly switch to another of the top 5 results, and the buttons allow you to mark the result as watched, favorite it, or in case of a tv show, view the episodes.
The dropdown allows you to quickly switch to another of the top 5 results, and the buttons allow you to mark the result
as watched, favorite it, or in case of a TV show, view the episodes. This menu is only shown if there was more than 1
result found for the query.

---

#### Search interface

![bg right 80%](img_2.png)
The buttons are interactive, and you can click on them to perform the action you want, such as marking a tv show as watched or adding it to your favorites list.
The buttons are interactive, and you can click on them to perform the action you want, such as marking a TV show as
watched or adding it to your favorites list.

> ℹ️ Marking an entire tv show as watched can sometimes take some time. There is no need to worry, the message will update when the operation is complete.
> ℹ️ Marking an entire TV show as watched can sometimes take some time (depending on how many episodes it has). There is
> no need to worry, the message will update when the operation is complete.
---

#### Episodes interface

![bg right 80%](img_3.png)
The episode interface is displayed when you click on the episodes button in the search interface.
Like the search interface, it provides a *Mark as watched* button for each episode. It also provides two dropdown menus, for quickly switching between seasons and episodes.
The episode interface is displayed when you click on the **View Episodes** button in the search interface.
Like the search interface, it provides a _Mark as watched_ button, so that you can track episodes
individually.

To choose between episodes, there are two dropdown menus, first for picking the seasons and second for the episode.

---

### Profile

The profile command very simply displays the profile of the specified user, or yours if you no user is specified.
The profile command displays various data and statistics for the specified user.
It has one (optional) option:
- `user`: to specify the user whose profile you want to view. If not specified, it will display your profile.

- `user`: To specify the user whose profile you want to view. If not specified, it will display your profile.

---

#### Profile interface

![bg right 80%](img_4.png)
The profile interface displays the user's profile, with the TV shows, movies and episodes watched, and the favorite list.
It does not provide any interactive elements, as it is only meant to display information.
You can click on any show's link to view more information about it on thetvdb.
The profile interface displays the user's profile. It contains the amount of TV shows, movies and episodes watched, and
a list with the shows marked as watched / favorite. It does not provide any interactive elements, as it is only meant
to display information, but you can click on any show's link to view more information about it on TheTVDB.

---

### Additional features

<Name> also has some additional features:
- A `/help` command to display a list of available commands
- A `/ping` command to check if the bot is online
- A `/sudo` command group, only available to the bot owner, to load, unload or reload extensions to improve the development experience

- A `/help` command to display a list of all available commands
- A `/ping` command to check if the bot is online and its latency
- A `/sudo` command group, only available to the bot owner, to load, unload or reload extensions to improve the
development experience.

---

### Additional features

![bg right 80%](img_5.png)
<Name> also has a custom rate limiter, both global and per user, to avoid spamming the bot with requests.
It also has a cache system to store the results from thetvdb and avoid making too many requests to the api, even though we did not find any information about rate limits on thetvdb's api documentation.
<Name> also has a custom rate limiting system, both global and per user, to avoid spamming the bot with requests.
Alongside that, we also added a cache system to store the results from TheTVDB and avoid flooding the api with the same
requests.

Even though we did not find any information about rate limits in the documentation for TheTVDB API, we didn't want to
abuse that fact and took the safer approach.

---

### Additional features
At last, <Name> has a built-in error handler to catch and show proper error messages to the user, instead of letting the command fail silently.

At last, <Name> has a built-in error handler to catch and show well formatted error messages to the user, directing
them to the GitHub repository where they can report the issue, instead of letting the command fail silently.

---

## Setting up

Before starting, there are some prerequisites you need to have:

- A discord bot token
- A thetvdb api key
- A directory on your host machine to store the database
- A TheTVDB API key
- A place on your host machine to store the database
- Docker and Docker Compose installed on your machine

---

## Setting up
In order to allow for an easy setup, we decide to go with Docker :whale: and Docker Compose for the deployment of the bot.
Since we use sqlite as a database, you will have to mount a volume to persist the data between restarts. Choose a directory on your host machine to store the database.
Then, create a docker-compose.yml file with the following content:

In order to allow for an easy and reproducible deployment setup, we decided to go with Docker :whale: and Docker
Compose for the bot.

Since we use SQLite as a database, you will have to mount a volume to persist the data between restarts. Choose a place
on your host machine to store this database and then create a `docker-compose.yml` file with the following content:

```yaml
version: '3.9'
version: "3.9"

services:
bot:
Expand All @@ -109,32 +174,51 @@ services:
---
## Setting up
You will also need to create a `.env` file in the same directory as the docker-compose.yml file.
There are two mandatory environment variables:
- `BOT_TOKEN`: the token of your discord bot
- `TVDB_API_KEY`: the api key for thetvdb (you can get one for free here: https://www.thetvdb.com/api-information)

- `BOT_TOKEN`: The token of your discord bot
- `TVDB_API_KEY`: The API key for TheTVDB (you can get one for free here: https://www.thetvdb.com/api-information)

```env
BOT_TOKEN=your_discord_bot_token
TVDB_API_KEY=your_thetvdb_api_key
```
This is the minimum configuration, but you can learn more about other environment variables [here](https://github.com/ItsDrike/code-jam-2024?tab=readme-ov-file#configuring-the-bot).

This is the minimal configuration, but you can learn more about other environment variables
[here](https://github.com/ItsDrike/code-jam-2024?tab=readme-ov-file#configuring-the-bot).

---

## Setting up
Once you have created the docker-compose.yml and .env files, you can start the bot by running the following command in the same directory as the files:

Once you have created the `docker-compose.yml` and `.env` files, you can start the bot by running the following command
in the same directory as the files:

```bash
docker-compose up -d
```

---

## Theme
Our project, <Name>, is linked to the theme of the jam, *Information overload*.
The link is present through the ability to quickly find information about medias, and get some statistics about what you have watched.
We also tried to keep the interface as simple, intuitive and easy to use as possible, to avoid overwhelming the user with information.

Our project, <Name>, was created with the theme of the jam in mind: _Information Overload_.

All of us have probably watched a bunch of different shows and movies, but after a while, keeping track of everything
that you've seen can get quite overwhelming.

The link to the theme is therefore present through the ability to quickly find information about these medias,
alongside its ability to keep track of what you have watched and liked for you. We also tried to keep the interface as
simple, intuitive and easy as possible, to avoid overwhelming the user with information.

---

## Contributions

- Core Bot Implementation:

- Basic bot: ItsDrike
- Logging: ItsDrike
- Error handling: ItsDrike
Expand All @@ -146,6 +230,7 @@ We also tried to keep the interface as simple, intuitive and easy to use as poss
---

- Database and ORM:

- Database models: ItsDrike, Paillat-dev, Benji
- Alembic migrations: ItsDrike

Expand All @@ -155,12 +240,14 @@ We also tried to keep the interface as simple, intuitive and easy to use as poss
---

- User Interface and Interactions:

- Help command: ItsDrike, Benji, Ash8121
- Profile command: ItsDrike
- Search command: ItsDrike, Paillat-dev
- Favoriting, watching and episodes UI and logic: ItsDrike, Paillat-dev, Benji

- Performance and Security:

- Cache: ItsDrike, Paillat-dev, Benji
- Rate limiter: ItsDrike

Expand Down

0 comments on commit b81e8b9

Please sign in to comment.