{"id":15641980,"url":"https://github.com/anandchowdhary/bookshelf-action","last_synced_at":"2025-04-05T22:09:47.256Z","repository":{"id":38173837,"uuid":"337790064","full_name":"AnandChowdhary/bookshelf-action","owner":"AnandChowdhary","description":"📚 Track your reading using GitHub Actions","archived":false,"fork":false,"pushed_at":"2024-11-16T19:17:48.000Z","size":24523,"stargazers_count":70,"open_issues_count":3,"forks_count":18,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-29T21:08:18.404Z","etag":null,"topics":["api","books","data","generator","github-actions","reading","tracker"],"latest_commit_sha":null,"homepage":"https://anandchowdhary.github.io/book-tracker/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AnandChowdhary.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2021-02-10T16:52:45.000Z","updated_at":"2025-03-21T16:58:25.000Z","dependencies_parsed_at":"2023-02-18T01:31:19.418Z","dependency_job_id":"607963e0-3ea3-452c-adc0-0725c5b78980","html_url":"https://github.com/AnandChowdhary/bookshelf-action","commit_stats":{"total_commits":234,"total_committers":9,"mean_commits":26.0,"dds":0.517094017094017,"last_synced_commit":"d6cd83bed908785b90059fc0f24c7ecaed4eb76b"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":"pabio/github-actions-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnandChowdhary%2Fbookshelf-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnandChowdhary%2Fbookshelf-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnandChowdhary%2Fbookshelf-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnandChowdhary%2Fbookshelf-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AnandChowdhary","download_url":"https://codeload.github.com/AnandChowdhary/bookshelf-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247406111,"owners_count":20933806,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["api","books","data","generator","github-actions","reading","tracker"],"created_at":"2024-10-03T11:53:13.927Z","updated_at":"2025-04-05T22:09:47.236Z","avatar_url":"https://github.com/AnandChowdhary.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [![Books Tracker](./assets/logo.svg)](https://anandchowdhary.github.io/bookshelf-action/)\n\nTrack your reading using repository issues and generate a README.md and open API automagically.\n\n[![Build CI](https://github.com/AnandChowdhary/bookshelf-action/workflows/Build%20CI/badge.svg)](https://github.com/AnandChowdhary/bookshelf-action/actions?query=workflow%3A%22Build+CI%22)\n[![Release CI](https://github.com/AnandChowdhary/bookshelf-action/workflows/Release%20CI/badge.svg)](https://github.com/AnandChowdhary/bookshelf-action/actions?query=workflow%3A%22Release+CI%22)\n[![Node CI](https://github.com/AnandChowdhary/bookshelf-action/workflows/Node%20CI/badge.svg)](https://github.com/AnandChowdhary/bookshelf-action/actions?query=workflow%3A%22Node+CI%22)\n\n[**View starter repository →**](https://github.com/AnandChowdhary/books)\n\n## ⭐ Features\n\n- End-to-end automated workflow using GitHub issues:\n  - Create GitHub issues to add the books you're reading\n  - Track your reading progress by adding comments to the issue\n  - Close the issue when you've completed the book\n- Get a README.md summary and JSON API for your reading data\n- Uses Google Books API to fetch details like cover and ISBN\n\n### Get started\n\nThis repository only includes the GitHub Actions required as dependencies. To get started, [**visit AnandChowdhary/books**](https://github.com/AnandChowdhary/books) and use it as a starting point. You can use the [Use this template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) button to create a new repository:\n\n1. Go to [AnandChowdhary/books](https://github.com/AnandChowdhary/books)\n2. Click on the \"Use this template\" button or fork the repository\n3. Add a book by creating a new issue with the book's name\n\n\u003cdetails\u003e\n  \u003csummary\u003eHow to add a new book\u003c/summary\u003e\n\nFirst, create a new issue in your repository:\n\n![Screenshot of new issue button](./assets/new-issue.png)\n\nThen, write the name of the book and author as the issue title:\n\n![Screenshot of issue title](./assets/book-title-in-issue.png)\n\nLastly, press the \"Submit new issue\" button and you'll see a comment and labels added automatically:\n\n![Screenshot of comment in issue](./assets/issue-bot-comment.png)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eHow to update reading progress\u003c/summary\u003e\n\nIn your book's issue, simply enter in plain text the progress. For example, \"I've reached page 100\" or \"I've completed 24%\", or \"I've reached page 42/542\". The issue title will be automatically updated to include your reading progress:\n\n![Screenshot of new issue button](./assets/issue-title-progress.png)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eHow to complete reading a book\u003c/summary\u003e\n\nWhen you've completed a book, simply close the issue. An automated comment will be added to tell you about your reading time and some new labels will be added.\n\n![Screenshot of new issue button](./assets/issue-close-completed.png)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eHow to add a book as \"Want to read\"\u003c/summary\u003e\n\nWhen creating a new issue for the book, add the label \"want to read\".\n\n\u003c/details\u003e\n\n## 📖 Example\n\nSimply create issues with names of books, and Bookshelf Action will automatically organize them with labels:\n\n![Screenshot of issues](./assets/issues.png)\n\nAdditionally, a summary of your reading progress is generated in the `README.md` file:\n\n![Screenshot of README](./assets/readme-demo.png)\n\n## 📄 License\n\n- Code: [MIT](./LICENSE) © [Anand Chowdhary](https://anandchowdhary.com)\n- Books icon by [Francielly Costantin Senra](https://thenounproject.com/franciellycs/) from [The Noun Project](https://thenounproject.com)\n- Merge icon by [Danil Polshin](https://thenounproject.com/everydaytemplate) from [The Noun Project](https://thenounproject.com)\n- \"GitHub\" is a trademark of GitHub, Inc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanandchowdhary%2Fbookshelf-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanandchowdhary%2Fbookshelf-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanandchowdhary%2Fbookshelf-action/lists"}