Skip to content

wustep/bookshelf

Repository files navigation

📚 Bookshelf

An interactive collection of books.

See: https://wustep-bookshelf.vercel.app/ for a live demo.

Getting Started

Prerequisites

  • Node.js 18+
  • npm

Installation

npm install

Development

npm run dev

Visit http://localhost:5173 to see your bookshelf.

Adding Books

Edit public/data/books.json to add your books:

{
  "books": [
    {
      "id": "1",
      "title": "Design as Art",
      "author": "Bruno Munari",
      "year": 2024,
      "date": "2024-03-15",
      "category": "Design",
      "color": "#E85D4C",
      "cover": "/data/covers/design-as-art.jpg",
      "notes": "My notes about this book...",
      "summary": "A brief summary of the book...",
      "quotes": ["Quote 1", "Quote 2"],
      "goodreadsLink": "https://goodreads.com/...",
      "amazonLink": "https://amazon.com/...",
      "link": "https://..."
    }
  ]
}

Book Properties

Property Type Description
id string Unique identifier
title string Book title
author string Author name
year number Year you read it (used if date not provided)
date string Full date read in YYYY-MM-DD format (optional, takes precedence over year)
category string Category (e.g., "Design", "Technology")
color string Accent color hex code
cover string Cover image URL or path (optional)
notes string Your personal notes (optional)
summary string Book summary (optional)
quotes array Favorite quotes (optional)
goodreadsLink string Goodreads URL (optional)
amazonLink string Amazon URL (optional)
link string Other external link (optional)

Tech Stack

  • Vite - Build tool
  • React - UI framework
  • CSS custom properties for theming

Inspiration

License

MIT

About

An interactive bookshelf

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published