Skip to content

docs: add Install with Appflare badge to README - #132

Closed
MendyLanda wants to merge 1 commit into
devarshishimpi:devfrom
MendyLanda:docs/appflare-install-badge
Closed

MendyLanda wants to merge 1 commit into
devarshishimpi:devfrom
MendyLanda:docs/appflare-install-badge

Conversation

@MendyLanda

Copy link
Copy Markdown

Description

Adds an "Install with Appflare" badge to the README header, linking to https://appflare.dev/install/codra/.

Appflare is an open-source manager that installs and updates Workers apps in your own Cloudflare account. Codra was just added to its catalog (appflare/catalog#199, listing at https://appflare.dev/apps/codra/). The catalog builds and signs the Worker from the v0.9.5 tag. At install time it creates the queue, Workflow, KV namespace and a Hyperdrive config from the user's Postgres connection string, generates the webhook secret and encryption key, and walks the user through creating the GitHub App and running npm run migrate. It runs on the Workers Free plan. New tags are picked up by the catalog's bump bot.

The badge is the HTML form from Appflare's badge docs, at 39 px so it matches the height of Cloudflare's Deploy button if you add one later. Feel free to move it, for example next to the installation links, or to drop it.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Chore (refactoring, dependency updates, etc.)

How Has This Been Tested?

README only. prettier --check README.md passes, and both https://appflare.dev/badge.svg and https://appflare.dev/install/codra/ return 200.

Checklist:

  • I have performed a self-review of my own code
  • My changes generate no new warnings

@codra-app-personal codra-app-personal Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codra Review

✅ Nothing to flag. Reviewed 1 file (10 changed lines) and found no issues worth raising.

Reviewed commit: e22e9fa884

ℹ️ About Codra in GitHub

Your team has set up Codra to review pull requests in this repo. Reviews are triggered when you:

  • Open a pull request for review
  • Mark a draft as ready

Every review posts a summary here. A clean pass also gets a 👍 on the pull request itself.

@devarshishimpi

Copy link
Copy Markdown
Owner

Thank you for the PR! @MendyLanda

However, due to working for Docker + Node.js runtime (along with CF) and more importantly, restructuring the docs (since Codra will have support for multiple deployment options), I'll be closing this PR. But, don't worry. This part is on me, I'll update the new docs to link Appflare!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants