mirror of
https://github.com/M4X809/list-of-lp.git
synced 2025-12-25 19:12:48 +00:00
Update README.md to include project disclaimer and refine tech stack details
- Added a disclaimer clarifying the fan-made nature of the project and its lack of affiliation with Linkin Park. - Removed the Project Structure and Getting Started sections for a more concise README. - Updated the React version in the tech stack section for accuracy.
This commit is contained in:
parent
23b8d363ec
commit
b0972796ba
1 changed files with 6 additions and 68 deletions
74
README.md
74
README.md
|
|
@ -2,6 +2,11 @@
|
||||||
|
|
||||||
A modern web application showcasing the complete discography of Linkin Park, built with Next.js 15 and React 19.
|
A modern web application showcasing the complete discography of Linkin Park, built with Next.js 15 and React 19.
|
||||||
|
|
||||||
|
> **Disclaimer:**
|
||||||
|
> This is a fan-made project and is not affiliated with Linkin Park or any of its members.
|
||||||
|
> All rights to music, artwork, and trademarks belong to their respective owners.
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- 🎵 Browse all Linkin Park albums
|
- 🎵 Browse all Linkin Park albums
|
||||||
|
|
@ -14,79 +19,12 @@ A modern web application showcasing the complete discography of Linkin Park, bui
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
|
|
||||||
- **Framework**: Next.js 15 (App Router)
|
- **Framework**: Next.js 15 (App Router)
|
||||||
- **React**: React 19 (Canary)
|
- **React**: React 19
|
||||||
- **UI Components**: Mantine Core 8.3.5
|
- **UI Components**: Mantine Core 8.3.5
|
||||||
- **Styling**: Tailwind CSS 4.1.15
|
- **Styling**: Tailwind CSS 4.1.15
|
||||||
- **Package Manager**: Bun
|
- **Package Manager**: Bun
|
||||||
- **TypeScript**: 5.9.3
|
- **TypeScript**: 5.9.3
|
||||||
|
|
||||||
## Project Structure
|
|
||||||
|
|
||||||
```
|
|
||||||
src/
|
|
||||||
├── app/
|
|
||||||
│ ├── layout.tsx # Root layout with Mantine provider
|
|
||||||
│ ├── page.tsx # Home page (server component)
|
|
||||||
│ └── album/
|
|
||||||
│ └── [albumId]/
|
|
||||||
│ ├── page.tsx # Album detail page (server component)
|
|
||||||
│ └── not-found.tsx
|
|
||||||
├── components/
|
|
||||||
│ ├── AlbumCard.tsx # Album card component (client component)
|
|
||||||
│ └── BackButton.tsx # Back button (client component)
|
|
||||||
├── lib/
|
|
||||||
│ ├── list.ts # Album data
|
|
||||||
│ └── ListTypes.ts # TypeScript types
|
|
||||||
└── index.css # Global styles
|
|
||||||
```
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
Install dependencies:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
bun install
|
|
||||||
```
|
|
||||||
|
|
||||||
Run the development server:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
bun run dev
|
|
||||||
```
|
|
||||||
|
|
||||||
Open [http://localhost:3000](http://localhost:3000) to view the app.
|
|
||||||
|
|
||||||
## Build
|
|
||||||
|
|
||||||
Build for production:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
bun run build
|
|
||||||
```
|
|
||||||
|
|
||||||
Start the production server:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
bun run start
|
|
||||||
```
|
|
||||||
|
|
||||||
## Features Explanation
|
|
||||||
|
|
||||||
### Server Components
|
|
||||||
|
|
||||||
The app leverages Next.js App Router with server components for optimal performance:
|
|
||||||
- Home page (`page.tsx`) - Server component that renders the album grid
|
|
||||||
- Album detail page (`album/[albumId]/page.tsx`) - Server component with static generation
|
|
||||||
|
|
||||||
### Client Components
|
|
||||||
|
|
||||||
Interactive components use the `"use client"` directive:
|
|
||||||
- `AlbumCard` - Handles click navigation to album details
|
|
||||||
- `BackButton` - Handles navigation back to home
|
|
||||||
|
|
||||||
### Static Generation
|
|
||||||
|
|
||||||
Album detail pages are statically generated at build time using `generateStaticParams`, providing instant page loads.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue