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

docs: align README markdown tables

Browse Source
This commit is contained in:
mkelvers
2026-06-21 16:52:19 +02:00
committed by Milas Holsting
parent 4bb9caa972
commit fb8433a435
1 changed files with 59 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -28,9 +28,8 @@ part of the project is the product shape: server-rendered pages, a local databas
integrations, playback proxying, recommendations, migrations, tests, and a TypeScript player that
only appears where browser state actually earns its place.
> [!NOTE]
> This is a personal, local-first project. It is written to demonstrate product engineering choices,
> not to present itself as an official MyAnimeList client or a hosted streaming platform.
> [!NOTE] This is a personal, local-first project. It is written to demonstrate product engineering
> choices, not to present itself as an official MyAnimeList client or a hosted streaming platform.
## Contents
@@ -60,7 +59,7 @@ the edges, and the UI is mostly rendered by the server.
## What It Includes
| Area | What it does |
| --- | --- |
| --------------- | ------------------------------------------------------------------------------------------------------------ |
| Catalog | Browse, search, and inspect anime metadata from external catalog sources. |
| Details | Render synopsis, reviews, characters, statistics, relations, themes, and watch-order data. |
| Watchlist | Store local user state for saved titles, statuses, and progress-driven flows. |
@@ -85,10 +84,11 @@ segments, episode completion, and thumbnail navigation.
## How It Is Built
The application is organized around product boundaries rather than framework layers. `internal/anime`
owns catalog-facing behavior, `internal/watchlist` owns saved user state, `internal/playback` owns
watch data and proxy behavior, and `integrations` contains provider clients. This keeps the core app
from depending directly on the details of a specific metadata or playback source.
The application is organized around product boundaries rather than framework layers.
`internal/anime` owns catalog-facing behavior, `internal/watchlist` owns saved user state,
`internal/playback` owns watch data and proxy behavior, and `integrations` contains provider
clients. This keeps the core app from depending directly on the details of a specific metadata or
playback source.
Server-rendered templates are the default because most pages are content-heavy and benefit from
simple request-response rendering. TypeScript is used where the browser has real ongoing state:
@@ -110,8 +110,8 @@ bun install
just dev
```
The development server runs on `http://localhost:3000` by default. `just dev` uses Air to rebuild the
Go server and frontend assets when relevant files change.
The development server runs on `http://localhost:3000` by default. `just dev` uses Air to rebuild
the Go server and frontend assets when relevant files change.
Create a local user with:
@@ -122,7 +122,7 @@ go run ./cmd/user <username> <password>
### Commands
| Command | Use it for |
| --- | --- |
| ------------------------------- | --------------------------------------------------- |
| `just setup` | Install pinned tools and Bun dependencies. |
| `just dev` | Run the app locally with live rebuilds. |
| `just build` | Build the Go binary, CSS, and TypeScript assets. |
@@ -139,7 +139,7 @@ go run ./cmd/user <username> <password>
Configuration is loaded from environment variables, and a local `.env` file is read automatically.
| Variable | Default | Purpose |
| --- | --- | --- |
| --------------------------- | --------------- | ------------------------------------------------------------------- |
| `PORT` | `3000` | HTTP port for the server. |
| `DATABASE_FILE` | `mal.db` | SQLite database path. |
| `GIN_MODE` | release default | Gin runtime mode. |
@@ -154,7 +154,7 @@ Configuration is loaded from environment variables, and a local `.env` file is r
<summary><strong>Maintenance commands</strong></summary>
| Command | Use it for |
| --- | --- |
| ------------------------ | ---------------------------------------------------------- |
| `just new-data-fix name` | Scaffold a new data-fix file. |
| `just run-fixes` | Run registered data fixes through `cmd/user`. |
| `just fix-all` | Run the Bun maintenance script for data fixes. |
@@ -165,7 +165,7 @@ Configuration is loaded from environment variables, and a local `.env` file is r
## Repository Map
| Path | Responsibility |
| --- | --- |
| -------------------------------- | --------------------------------------------------------------- |
| `cmd/server` | Web server entry point. |
| `cmd/user` | Local user and maintenance commands. |
| `internal/anime` | Catalog, details, browse, search, reviews, and recommendations. |