# CommaFeed Podcasts

<p align="center">
  <img width="200" src="./src/assets/logo.svg" alt="CommaFeed Podcasts logo">
</p>

> **Experimental / WIP** – A progressive web application for podcast consumption, powered by [CommaFeed](https://github.com/Athou/commafeed) as the backend.

## Links
- [Plan](./changelog/PLAN.md), [Task](./changelog/TASK.md)
- [![Built with open-wc recommendations](https://img.shields.io/badge/built%20with-open--wc-blue.svg)](https://github.com/open-wc)
- [What is Lit? – Lit](https://lit.dev/docs/)
- [@lit-labs/router - npm](https://www.npmjs.com/package/@lit-labs/router)
- [lit-translate - npm](https://www.npmjs.com/package/lit-translate)

## Features
- **PWA** support with offline caching.
- Client‑side routing via a lightweight router.
- Dynamic page rendering based on URL parameters (e.g., `/episodes/:id`).
- Built with Lit, TypeScript and Open‑WC tooling.

## Getting Started
```bash
npm install
bs/start
```

## Build Scripts
See [bs/README.md](./bs/README.md) for available build and deployment scripts.

## Testing
Tests are written with `@open-wc/testing` (Mocha) / Web Test Runner and follow the `*.test.ts` convention. Run all tests via:
```bash
bs/test
```

## Documentation
- Overall development plan: [docs/dev/PLAN.md](./docs/dev/PLAN.md)
- Overall task board: [docs/dev/TASK.md](./docs/dev/TASK.md)
- App source overview: [src/README.md](./src/README.md)

## Contributing
TBD
<!--
Pull requests are welcome! Please read the contributing guidelines in `CONTRIBUTING.md` (if present) or open an issue to discuss major changes.
-->

## License
[MIT](LICENSE)