Mini Mealie is a Chrome extension built using WXT and React, designed to speed up recipe creation. This extension integrates with Mealie to scrape recipes and import into Mealie.
- Import recipes from any webpage using Mealie API
- Toggle for Paywall ladder
- Each website uses Mealie dry-run to detect a recipe on the active tab
- Store Mealie API token securely using
chrome.storage.sync. - Supports connecting to any Mealie server
- Node.js v22.x or later
- pnpm (Package Manager)
- Chrome (for testing and development)
- Dependencies:
- WXT (Web Extension Toolkit)
- React v19.x
- TypeScript 5.7.3
-
Clone the repository:
-
Install dependencies using pnpm:
pnpm install
-
Start the development server:
pnpm dev
-
Build the extension for production:
pnpm build
-
Load the extension in Chrome:
- Go to
chrome://extensions/ - Enable Developer Mode
- Click Load unpacked and select the
distfolder
- Go to
- To use the Mealie integration, you will need to generate an API token in your Mealie instance.
- Save the token securely within the extension popup.
- Obtain your local host URL or public Mealie instance URL for API calls.
- Modify your Mealie infrastructure to allow CORS (Cross-Origin Resource Sharing) calls, as the Chrome extension will be making API requests:
- This involves configuring your reverse proxies, authentication, or other related infrastructure.
- Right-click on any recipe webpage.
- Select "Recipe Detected - Add Recipe to Mealie" from the context menu. 2a. (Optional) Enable the paywall ladder feature to send the recipe URL to a paywall ladder before proceeding.
- The extension will send the recipe URL to the Mealie create recipe endpoint.
- Open Source Invitation:
- Contributions are welcome as Mini Mealie evolves. Enhance features or propose new ones!
- Discussion and Issues:
- Use the discussion page for suggestions or issue troubleshooting. Feel free to create detailed issues for bugs or desired features.
-
Branches:
main: Stable production build.- Develop new features or fixes in a feature branch.
- Open a pull request (PR) pointing to
main.
-
Review:
- Request a review from a repository admin.
-
Release Management:
- After a successful review and merge, a GitHub Action evaluates if a new release is necessary based on the PR commits.
- This project follows Conventional Commits for release determination.
- Approved releases are published to the Chrome Web Store via an upload workflow.
- All pull request reviews must be kept up-to-date with the
mainbranch. - Branch protection rules are enforced to ensure:
- Passing of ESLint tests.
- Successful completion of unit tests.
- Adequate test coverage is maintained.
- All issues must be resolved prior to requesting a review.
- Pull requests require approval from at least one reviewer.
Distributed under the AGPL License. See the LICENSE file for more details.
If you find this project useful, consider buying me a coffee to show your support!
For questions or collaboration requests, contact:
- Adam Shappy - [email protected]
- GitHub - https://github.com/mrshappy0
