Skip to content

adicoding-js/The-Expeditor

Repository files navigation

🍳 The Expeditor

A Chrome Extension for Flavortown Shipwrights to speed-review GitHub ReadME's / Projects.

[Download v1.0.0 (.crx)] (https://github.com/adicoding-js/The-Expeditor/releases/download/v1.0.0/FlavorZone.crx)


Features

πŸ“‹ Smart Ticket (README Parser)

  • Opens in Chrome Side Panel on any GitHub repo
  • AI extracts all features and tech stack from README
  • Displays as a kitchen-style paper ticket
  • AI detection badge (πŸ€–) warns if README feels AI-generated

⌨️ Text Shortcuts

Type these anywhere on GitHub or Flavortown, then press Space:

Shortcut Expands To
/prob "The project is cool but {cursor}"
/good "Great work! I especially liked {cursor}"
/fix "Ok the Project is soo cool but {problem} so please fix: {cursor}"
/ship "🚒 Ship approved! Ready for production."
/vote "⭐ FULL Vote from my side! This project deserves cookies"

πŸ”§ Custom Commands

Add your own shortcuts in Settings βš™οΈ!

πŸ“ Garnish (Quick Feedback)

One-click copy buttons: Missing Readme, Good Job, Spaghetti Code, No License


Installation

  1. Download/clone this repo
  2. Go to chrome://extensions
  3. Enable Developer mode (top right)
  4. Click Load unpacked β†’ select this folder
  5. Click the extension icon β†’ opens Side Panel

NOTE:

  • This Extension Does have an .crx release, but chrome heavliy denies .crx from unauthorized sources.

API Key Setup

  1. Open the extension side panel.
  2. Click the settings button.
  3. Paste your Gemini API key in Gemini API Key (Required for README analysis).
  4. Click Save Preferences.

If no key is saved, README analysis is skipped and the UI will prompt you to add one in Settings.

Security Note

  • API keys are not hardcoded in tracked source files.
  • The key is stored at runtime in chrome.storage.local.
  • This prevents repo leaks, but a client-side extension cannot fully hide a key from a local user.

Dev Script (list_models.js)

  • Bash/Zsh:
    • GEMINI_API_KEY=your_key_here node list_models.js
  • PowerShell:
    • $env:GEMINI_API_KEY='your_key_here'; node list_models.js

Tech Stack

  • HTML, CSS, Vanilla JS
  • Chrome Manifest V3 + Side Panel API
  • Gemini 2.5 Flash for AI analysis ( Bring your own key AS HACKCLUB AI is down right now, at the time of this project)
  • chrome.storage.sync for cross-tab snippets
  • chrome.storage.local for runtime API key storage

Screenshots

Open the extension on any GitHub repo to see the kitchen ticket in action!

This ReadME is made with the help of ai...


Made with πŸ’– for Flavortown by adicoding-js πŸ‘¨β€πŸ³πŸ’–.

About

A Chrome Extension for Flavortown Shipwrights to speed-review GitHub ReadME's / Projects.

Resources

Stars

Watchers

Forks

Packages

No packages published