🔤 Adds plan

This commit is contained in:
2026-06-11 14:01:51 +02:00
parent 8fe3a87ee2
commit c000517fd1
2 changed files with 45 additions and 0 deletions
+44
View File
@@ -0,0 +1,44 @@
# Basic Episodes Fetch
## Overview
This plan focuses on adding a minimal **episodesfetch** feature that pulls podcast episodes from the CommaFeed backend
using environment variables for configuration.
The plan is derived from:
- `docs/dev/README.md` (API endpoints, authentication)
- `src/` structure and existing route system
- Build scripts in `bs/` only linting is required at this stage.
## Tasks
1. **Environment handling** (TODO)
- Create a small helper (`@core/env.ts`) that reads `.env.ts` (or falls back to process.env).
- Expose constants: `COMMAFEED_URL`, `USERNAME`, `PASSWORD`.
1. **API client** (TODO)
- Adds `src/api` folder to the project structure (update also @src/README.md).
- Implement a lightweight wrapper around `fetch` in `src/api/index.ts`.
- Build `authHeader()` that returns the BasicAuth header using env vars.
1. **Episode service** (TODO)
- Add `src/api/episodes.ts` with `getEpisodes(feedId)` and `getEpisode(id)`.
- Add data types
- Use `/rest/feed/entries?feed_id=${feedId}` endpoint.
1. **Route integration** (TODO)
- In `app-episodes/routes.ts`, call the service during `enter()` to prefetch episodes.
- Pass fetched data via route context or set a global state (e.g., using Lit Labs signals).
1. **Page update** (TODO)
- Update `<app-episodes>` to reflect loading state(s).
- Add episode list item component.
- Update `<app-episodes>` to render the episode list received from the route context.
1. **Testing** (TODO)
- Add unit tests for `api/*.ts` using project test setup.
- Add unit test for created component(s)
1. **Linting** (TODO)
- Ensure all new files satisfy the lint rule defined in `bs/dev/lint`.
## Expected Output
- Visiting `/episodes/` will display a list of episodes fetched from CommaFeed.
- Episodes are identified by their `id` and displayed with title, publish date, and an audio link if available.
- Authentication uses the env variables; no credentials are hardcoded in source.
---
> **Note**: This plan intentionally keeps external dependencies minimal. It can be extended later for pagination, caching, or offline support.
+1
View File
@@ -2,3 +2,4 @@
- [x] initial setup (`bs`, app structure, …) - [x] initial setup (`bs`, app structure, …)
- [x] adds routing support - [x] adds routing support
- [ ] [episodes basic fetch](./plans/plan-basic-episodes.md)