radio-station/README.md

Awesome Radio

Awesome Radio is a personal internet radio station aggregator.

Features

• Browse radio stations by tag
• Listen while navigating
• Fully responsive UI for mobile, tablets, and desktop
• Light and dark theme automatically enabled by OS settings
• Deep linking for all UI actions
• User accounts
• Add content sources to import stations

Roadmap

• Support user favorites
• Support importing from other source types
• Support manually adding/editing/disabling stations
• Support PWA to allow user to save to home screen on mobile devices
• Fix: Primary drawer stays open after navigation
• Tech Debt: Add more unit and E2E tests

Development

Tech Stack

• Remix: React SSR web framework
• SQLite: File based relational database
• Prisma: Node TS ORM
• Vitest: Unit test framework

Getting Started

1. Create .env file from .env.example

cp .env.example .env

2. Migrate & Seed the SQLite DB

npx prisma migrate deploy
npx prisma db seed

Running

npm run dev

Testing

Run unit tests

npm run test

Run E2E tests

npm run test:e2e:run

Run all checks

npm run validate