https://github.com/abhagsain/read-changelogs
📑 Search & Read Github Releases Of Multiple Packages On A Single Page
https://github.com/abhagsain/read-changelogs
hacktoberfest javascript npm packages release release-notes release-notes-generateor releasenotes typescript
Last synced: about 2 months ago
JSON representation
📑 Search & Read Github Releases Of Multiple Packages On A Single Page
- Host: GitHub
- URL: https://github.com/abhagsain/read-changelogs
- Owner: abhagsain
- Created: 2022-09-12T14:11:42.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-04T11:39:58.000Z (over 3 years ago)
- Last Synced: 2026-01-23T05:54:10.819Z (3 months ago)
- Topics: hacktoberfest, javascript, npm, packages, release, release-notes, release-notes-generateor, releasenotes, typescript
- Language: CSS
- Homepage: https://changelogs.sideprojects.fun/
- Size: 2.11 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📑 Read release notes for multiple packages on a single page
It's a pain to search for release notes of different packages while upgrading a project. That's why created this project.
[You can read this tweet for more info](https://twitter.com/abhagsain/status/1569352819941216257)
## Installation
1. Clone this repo
2. `npm i` and `npm run dev`
## Contributing Guide
There's a rate-limit (10 req/minute) for unauthenticated users for Github's API.
That's why I'm caching the response With [Cloudflare Worker's KV](https://www.cloudflare.com/products/workers-kv/) so you will need to create an account on Cloudflare and install [Wrangler CLI (Please Follow the instructions)](https://developers.cloudflare.com/workers/wrangler/)
Don't worry you won't be charged anything, there's a generous free limit of 100K req/day.
Once the CLI is installed create a KV namespae
- `wrangler kv:namespace create RELEASE` & `wrangler kv:namespace create RELEASE --preview`
- Replace the `id` and `preview_id` (from the second command 👆) in `wrangler.toml`
- Now you can run `npm run worker-dev` to run the worker locally and `npm run worker-publish` to publish your changes to Cloudflare. (Again you won't be charged anyting for publishing the worker)
## Found this useful?
## Tech Stack
This projet uses
- [TypeScript](https://typescriptlang.org/)
- [Remix](https://remix.run/docs/en/v1)
- [TailwindCSS](https://tailwindcss.com/)
- [Itty Router](https://github.com/kwhitley/itty-router) for CF Worker routing
- [Cloudflare Worker KV](https://developers.cloudflare.com/workers/learning/how-kv-works/) for caching
__
Love to build stuff?
Connect with me on [Twitter](https://twitter.com/abhagsain) or [LinkedIn](https://linkedin.com/in/anurag-bhagsain/) :)