Update README.md
This commit is contained in:
29
README.md
29
README.md
@@ -1,6 +1,6 @@
|
|||||||

|

|
||||||
# stillnavidrome (project still)
|
# mice (project still reworked)
|
||||||
> still water, now with navidrome
|
> project still, now with navidrome
|
||||||
|
|
||||||
> project based on [shadcn/ui](https://github.com/shadcn-ui/ui)'s music template
|
> project based on [shadcn/ui](https://github.com/shadcn-ui/ui)'s music template
|
||||||
|
|
||||||
@@ -20,7 +20,7 @@ This is a modern music streaming web application built with [Next.js](https://ne
|
|||||||
- 📊 **Scrobbling** - Track your listening history
|
- 📊 **Scrobbling** - Track your listening history
|
||||||
|
|
||||||
### Preview
|
### Preview
|
||||||

|

|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
@@ -41,7 +41,7 @@ pnpm install
|
|||||||
2. **Configure Navidrome connection**
|
2. **Configure Navidrome connection**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cp .env.example .env.local
|
cp .env.example .env
|
||||||
```
|
```
|
||||||
|
|
||||||
Edit `.env.local` with your Navidrome server details:
|
Edit `.env.local` with your Navidrome server details:
|
||||||
@@ -72,25 +72,6 @@ This project was migrated from Firebase to Navidrome. See [NAVIDROME_MIGRATION.m
|
|||||||
- **Audio**: Web Audio API with streaming
|
- **Audio**: Web Audio API with streaming
|
||||||
- **State**: React Context for global state management
|
- **State**: React Context for global state management
|
||||||
|
|
||||||
## Project Structure
|
|
||||||
```
|
|
||||||
lib/
|
|
||||||
navidrome.ts # Navidrome API client
|
|
||||||
app/
|
|
||||||
components/
|
|
||||||
NavidromeContext.tsx # Data provider for Navidrome
|
|
||||||
AudioPlayerContext.tsx # Audio player state management
|
|
||||||
album-artwork.tsx # Album display component
|
|
||||||
artist-icon.tsx # Artist display component
|
|
||||||
AudioPlayer.tsx # Main audio player
|
|
||||||
library/ # Library pages
|
|
||||||
albums/ # Albums view
|
|
||||||
artists/ # Artists view
|
|
||||||
playlists/ # Playlists view
|
|
||||||
album/[id]/ # Album detail page
|
|
||||||
artist/[artist]/ # Artist detail page
|
|
||||||
```
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
1. Fork the repository
|
1. Fork the repository
|
||||||
|
|||||||
Reference in New Issue
Block a user