melosh/mal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

style: format dev docs and hook config

Browse Source
This commit is contained in:
mkelvers
2026-06-21 01:48:48 +02:00
committed by Milas Holsting
parent 8219e83135
commit 7ab263ae2d
3 changed files with 37 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -12,13 +12,20 @@
<img alt="License" src="https://img.shields.io/badge/license-MIT-green?style=flat-square" />
</p>
MyAnimeList is a small self-hosted anime tracker and playback app. It keeps the catalog, watchlist, progress tracking, and player in one place, backed by a single SQLite database and a single Go server.
MyAnimeList is a small self-hosted anime tracker and playback app. It keeps the catalog, watchlist,
progress tracking, and player in one place, backed by a single SQLite database and a single Go
server.
Most of the UI is rendered on the server. HTMX handles lightweight updates like pagination and watchlist changes, while TypeScript is kept for the parts that need real browser state: the video player, search page, theme handling, and skip segment editor. The app also includes local users, API tokens, subtitle support, playlist rewriting, provider integrations, migrations, and startup data fixes.
Most of the UI is rendered on the server. HTMX handles lightweight updates like pagination and
watchlist changes, while TypeScript is kept for the parts that need real browser state: the video
player, search page, theme handling, and skip segment editor. The app also includes local users, API
tokens, subtitle support, playlist rewriting, provider integrations, migrations, and startup data
fixes.
## Running
Requires [`mise`](https://mise.jdx.dev/), a C compiler for SQLite, and the tools managed in `.mise.toml`.
Requires [`mise`](https://mise.jdx.dev/), a C compiler for SQLite, and the tools managed in
`.mise.toml`.
```bash
mise install
@@ -28,11 +35,17 @@ go run ./cmd/user <username> <password>
just dev
```
The app starts on `http://localhost:3000` by default. Configuration comes from environment variables, and a local `.env` file is loaded automatically. The most useful options are `PORT`, `DATABASE_FILE`, `PLAYBACK_PROXY_SECRET`, `EPISODE_AVAILABILITY_MODE`, and `ANIMESCHEDULE_API_TOKEN`.
The app starts on `http://localhost:3000` by default. Configuration comes from environment
variables, and a local `.env` file is loaded automatically. The most useful options are `PORT`,
`DATABASE_FILE`, `PLAYBACK_PROXY_SECRET`, `EPISODE_AVAILABILITY_MODE`, and
`ANIMESCHEDULE_API_TOKEN`.
## Development
The codebase is split between Go feature packages, external integrations, server-rendered templates, and a small frontend asset pipeline. `cmd/server` starts the web app, `cmd/user` contains local admin tools, `internal` holds the application modules, `integrations` holds provider clients, and `templates`, `static`, and `dist` contain the UI.
The codebase is split between Go feature packages, external integrations, server-rendered templates,
and a small frontend asset pipeline. `cmd/server` starts the web app, `cmd/user` contains local
admin tools, `internal` holds the application modules, `integrations` holds provider clients, and
`templates`, `static`, and `dist` contain the UI.
The common development commands are in the `justfile`.