This is a simple GUI for Rclone. Currently it's very hard-coded and expects the user to have a specific folder structure along with a pre-configured rclone remote, alongside a TMDB API key.
The app is currently not being actively developed, it was made as a proof of concept and to learn more about Tauri, Rclone and JavaScript in general. In the future, I might come back to this project and actually make it properly configurable and user-friendly.
showcase.mp4
- List files and folders in a remote
- Get metadata for movies and series from TMDB
- Multi-platform (Windows and Linux)
- Available in English, Portuguese and Spanish
The app is built using Tauri, a framework for building desktop apps with web technologies. The backend is written in Rust and the frontend is written in TypeScript using Svelte.
An Rclone instance is spawned as a child process and communicates with the app in order to get the list of files and folders in the remote.
With the list of files and folders, the app then queries the TMDB API to get the metadata for each movie and series, this includes the title, release date, poster and backdrop images, and the overview.
The app is available in English, Portuguese and Spanish, and the user can switch between the languages at any time, this also affects the metadata that is fetched from TMDB. The internationalization is done using the i18next library.
- Windows or Linux
- Node.js
- NPM (or your favorite package manager)
- Rclone config (windows and linux binaries are included already)
- TMDB API key
- Rust
- Tauri prerequisites
You need to have a pre-configured rclone remote. The app expects a encrypted remote with the name piratinha-crypt
. However, an unencrypted remote with the same name should work as well.
It should have the following folder structure:
piratinha-crypt:/
├── Filmes/
│ ├── The first movie (year)/
│ ├── The second movie (2015)/
│ └── The nth movie (2034)/
├── Series/
│ ├── The first series (year optional)/
│ ├── The second series/
│ └── The nth series (2034)/
└── Jogos/
The Jogos
folder is optional as it was never properly implemented.
The rclone.conf file should be placed in src-tauri/assets
You need to have a TMDB API key. You can get one following their guide here.
Once you have your API key, you should place it in a file called .env
in the root of the project (next to this README.md file). The file should look like this:
VITE_TMDB_API_KEY="your_api_key_here"
First, install the dependencies:
npm install
Then, run the app:
npm run 'tauri dev'
This project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3 - see the LICENSE file for details