https://github.com/dotmavriq/teal
The Essential Aggregator Library
https://github.com/dotmavriq/teal
discogs goodreads imdb-webscrapping laravel mobygames steam
Last synced: 3 months ago
JSON representation
The Essential Aggregator Library
- Host: GitHub
- URL: https://github.com/dotmavriq/teal
- Owner: dotMavriQ
- Created: 2023-06-29T08:59:28.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-10T01:28:45.000Z (4 months ago)
- Last Synced: 2026-02-10T06:48:26.325Z (4 months ago)
- Topics: discogs, goodreads, imdb-webscrapping, laravel, mobygames, steam
- Language: Blade
- Homepage:
- Size: 653 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TEAL
**The Essential Aggregator Library** — a self-hosted media tracker for books, movies, and anime.
Built with Laravel 12, Livewire 3, and Tailwind CSS. Uses SQLite by default.
## What it does
- Track books, movies, and anime with status, ratings, dates, and notes
- Import from Goodreads (CSV), IMDb (CSV), and MyAnimeList (XML export / username)
- Fetch metadata and covers from OpenLibrary, TMDB, and Jikan (MAL)
- Gallery and list views with search, filtering, and sorting
- Reading queue for books
- Two themes out of the box (light and Gruvbox Dark)
- Single-user, per-account data isolation via policies
## Setup
Requires PHP 8.2+, Composer, Node.js, and npm.
```bash
git clone https://github.com/dotMavriQ/teal.git
cd teal
composer setup
```
`composer setup` handles dependency installation, `.env` creation, key generation, migrations, and asset building.
To start a dev server with queue worker, log tailing, and Vite:
```bash
composer dev
```
Or just the basics:
```bash
php artisan serve
```
Register an account at `/register` and you're in.
## External services (optional)
Movie metadata uses TMDB. If you want it, grab an API key from [themoviedb.org](https://www.themoviedb.org/settings/api) and add it to `.env`:
```
TMDB_API_KEY=your_key
TMDB_ACCESS_TOKEN=your_token
```
Book metadata (OpenLibrary) and anime metadata (Jikan/MAL) work without API keys.
## License
MIT