https://github.com/yashkarthik/skimmr
Browser extension that helps you skim articles
https://github.com/yashkarthik/skimmr
browser-extension chrome chrome-extension extension gpt-3 summarization
Last synced: about 2 months ago
JSON representation
Browser extension that helps you skim articles
- Host: GitHub
- URL: https://github.com/yashkarthik/skimmr
- Owner: YashKarthik
- Created: 2022-12-15T11:58:43.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T07:36:27.000Z (over 3 years ago)
- Last Synced: 2024-12-31T15:15:22.308Z (over 1 year ago)
- Topics: browser-extension, chrome, chrome-extension, extension, gpt-3, summarization
- Language: Astro
- Homepage: https://skimmr.xyz
- Size: 1.15 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Skimmr.xyz](https://skimmr.xyz)
A browser extension to help you _skim_ articles at the speed of your internet.
# Self-hosting / how to not get rate-limitted (for devs)
1. Clone the git repo.
```sh
git clone git@github.com:YashKarthik/skimmr.git
```
## Configuring API
1. Create a `.env` file in `/skimmr.xyz` folder.
2. Get your OpenAI API keys from [here](beta.openai.com/) and paste them in the `.env file` like so: `OPENAI_API_KEY=""`
3. Open `/skimmr.xyz/netlify/functios/gpt-summarize.ts` and remove the lines marked "Remove if self-hosting" in the comments.
4. Deploy to Netlify (or whatever serverless platform you use).
## Loading the extension
1. Open Chromium and type `chrome://extensions` in the URL bar.
2. Turn on developer mode.
3. Click load unpacked extension.
4. Go to the project root and load `manifest.json` in `/chrome`.