{"id":50938671,"url":"https://github.com/corychainsman/bookshelf","last_synced_at":"2026-06-17T11:37:59.786Z","repository":{"id":338068521,"uuid":"1156439446","full_name":"corychainsman/bookshelf","owner":"corychainsman","description":"Books I read","archived":false,"fork":false,"pushed_at":"2026-02-12T19:54:48.000Z","size":229,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-13T00:54:23.097Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://corychainsman.github.io/bookshelf/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/corychainsman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-12T16:45:05.000Z","updated_at":"2026-02-12T19:54:52.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/corychainsman/bookshelf","commit_stats":null,"previous_names":["corychainsman/bookshelf"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/corychainsman/bookshelf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corychainsman%2Fbookshelf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corychainsman%2Fbookshelf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corychainsman%2Fbookshelf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corychainsman%2Fbookshelf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/corychainsman","download_url":"https://codeload.github.com/corychainsman/bookshelf/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corychainsman%2Fbookshelf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34447266,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-17T02:00:05.408Z","response_time":127,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-17T11:37:58.925Z","updated_at":"2026-06-17T11:37:59.780Z","avatar_url":"https://github.com/corychainsman.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📚 Bookshelf\n\nA personal reading dashboard that turns Obsidian book notes into an interactive web app — grid view, Gantt timeline, and trends charts. Hosted free on GitHub Pages.\n\n**Live demo:** https://corychainsman.github.io/bookshelf/\n\n---\n\n## What it looks like\n\n- **Grid view** — cover thumbnails with title, author, rating, format, source, dates, and color-coded topic tags\n- **Timeline view** — Gantt chart of every book by reading period; pinch/scroll to zoom, color by topic/format/source/rating\n- **Trends view** — charts of reading pace, ratings, topic breakdown over time\n- All filters, view, zoom level, and color scheme are encoded in the URL so links are shareable and bookmarkable\n\n---\n\n## How it works\n\n```\nObsidian notes (YAML frontmatter)\n        ↓\n  generate_books_json.py\n        ↓\n   public/books.json\n        ↓\n  Vite + React app\n        ↓\n  GitHub Pages\n```\n\n### 1. Obsidian notes\n\nEach book is a Markdown file with YAML frontmatter. The script reads all `.md` files from a folder (e.g. `Books I Have Read`) and expects these fields:\n\n```yaml\n---\nfull_title: A Brief History of Intelligence\nauthor:\n  - Max S. Bennett\nrating: 9               # 0–10\nstart_date: 2025-07-06\nend_date: 2025-07-24\nformat: audiobook       # audiobook | ebook\nwhere_i_got_it: Libby\nfinished: true\nISBN: '9780063286368'\nimage_url: https://...  # cover image (optional but nice)\nrecommender: null\nthoughts: null\n---\n```\n\nYou don't need Obsidian specifically — any system that produces Markdown files with YAML frontmatter will work. The `_filename` field (the note's stem) is used as the unique ID.\n\n### 2. Generate books.json\n\n```bash\npip install pyyaml\npython generate_books_json.py\n```\n\nEdit the two paths at the top of the script:\n\n```python\nVAULT_DIR = Path(\"/path/to/your/Books I Have Read\")\nOUT_FILE  = Path(\"./public/books.json\")\n```\n\nRe-run this whenever you add or update a book note.\n\n### 3. Topic assignment\n\nTopics are stored directly in the book's YAML frontmatter as a list:\n\n```yaml\ntopics:\n  - Science\n  - Psychology\n```\n\n`generate_books_json.py` picks them up automatically — no separate file needed. If a book has no `topics` field, it defaults to `[\"Uncategorized\"]`.\n\nThe canonical topic list and their colors live in `src/colors.ts` — edit that file to add your own topics.\n\n### 4. Cover images\n\nThe `image_url` field in frontmatter drives the cover art. The easiest way to populate these is with the [Google Books API](https://developers.google.com/books):\n\n```python\nimport requests\n\ndef get_cover(isbn):\n    r = requests.get(f\"https://www.googleapis.com/books/v1/volumes?q=isbn:{isbn}\u0026key=YOUR_KEY\")\n    items = r.json().get(\"items\", [])\n    if items:\n        return items[0][\"volumeInfo\"].get(\"imageLinks\", {}).get(\"thumbnail\")\n```\n\n---\n\n## Running locally\n\n```bash\nnpm install\nnpm run dev\n```\n\nRuns at `http://localhost:3847`. The `books.json` in `public/` is loaded at runtime so you can update it without rebuilding.\n\n---\n\n## Deploying to GitHub Pages\n\n1. Fork this repo\n2. Go to **Settings → Pages → Source → GitHub Actions**\n3. Push to `main` — the workflow in `.github/workflows/deploy.yml` builds and deploys automatically\n\nThe `base` in `vite.config.ts` is set to `/bookshelf/` — change it to your repo name if you fork under a different name:\n\n```ts\nexport default defineConfig({\n  base: '/your-repo-name/',\n  // ...\n})\n```\n\n---\n\n## Customizing\n\n| File | What to change |\n|---|---|\n| `src/colors.ts` | Topic colors, format colors, rating gradient |\n| `src/topicMap.ts` | Book → topic assignments |\n| `src/components/FilterBar.tsx` | Filter options (e.g. add your own sources) |\n| `src/index.css` | Theme variables (dark/light colors, accent) |\n| `generate_books_json.py` | Input path, output path, extra fields |\n\n---\n\n## Tech stack\n\n- [Vite](https://vitejs.dev/) + [React](https://react.dev/) + TypeScript\n- [Tailwind CSS v4](https://tailwindcss.com/)\n- [Recharts](https://recharts.org/) (trends charts)\n- [GitHub Actions](https://docs.github.com/en/actions) + [GitHub Pages](https://pages.github.com/) (free hosting)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorychainsman%2Fbookshelf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcorychainsman%2Fbookshelf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorychainsman%2Fbookshelf/lists"}