frontend-auto-cms
v1.0.22
Published
Turn any frontend into an editable mini-CMS with one import.
Maintainers
Readme
frontend-auto-cms
Turn any frontend into an editable mini-CMS with one import and a dashboard route.
- Repository: https://github.com/Gabo-Tech/frontend-auto-cms
Quick Start
npm i frontend-auto-cms@latest
npx frontend-auto-cms setupThen add this in your app entry file:
import "frontend-auto-cms";Open your dashboard route (default: /dashboard) and start editing.
Install
npm i frontend-auto-cms@latestSetup
Run setup in your app project:
npx frontend-auto-cms setupSetup will:
- ask for CMS passcode
- configure dashboard route
- detect editable pages/files
- generate runtime config files
- configure hosting and publish provider (GitHub/GitLab)
- generate
public/cms-route-map.jsonfor route-to-source mapping
Real setup example
anonymous@anonymous:~/Documents/Programming/testlanding$ npm i frontend-auto-cms@latest
changed 1 package, and audited 198 packages in 970ms
38 packages are looking for funding
run `npm fund` for details
found 0 vulnerabilities
anonymous@anonymous:~/Documents/Programming/testlanding$ npx frontend-auto-cms setup
✔ Choose your CMS passcode: **********
✔ Dashboard route path (for editors): /dashboard
✔ Enable automatic translation via third-party API? Yes
✔ Where is your app deployed (for dashboard routing)? Vercel (auto-add
dashboard rewrites)
✔ Where is your code hosted for Save & Publish? GitHub
✔ Repository slug (owner/repo or group/project): Gabo-Tech/testlanding
✔ Branch to publish to: main
frontend-auto-cms initialized successfully.
- Config: .cms-config.json
- Content: cms-content.json
- Assets directory: public/cms-assets
- Runtime auth: public/cms-runtime-auth.json
- Hosting config: .cms-hosting.json
- Runtime hosting: public/cms-hosting.json
- Runtime settings: public/cms-settings.json
- Runtime locales: public/cms-locales.json
- Hosting routing: vercel.json rewrites: unchanged
- Automation: GitHub auto-apply workflow: unchanged
- Detected pages: /, /about, /careers, /contact, /faq, /home, /notfound, /services
Next steps:
1) Add `import "frontend-auto-cms";` to your frontend entry file.
2) Open /dashboard to edit your site.
3) After edits, click Save + Publish (or export patch and run apply).Use In Your App
Add this to your frontend entry file:
import "frontend-auto-cms";Then open your dashboard route (default: /dashboard).
Save + Publish behavior
- Applies edits in the dashboard preview immediately.
- Builds source patch operations from editable nodes.
- Resolves route mappings using
public/cms-route-map.json. - Publishes content/locales/patch files.
- Updates real repository source files via GitHub/GitLab APIs when configured.
Commands
npx frontend-auto-cms setup- regenerate config, pages, and route map.npx frontend-auto-cms apply- applycms-export.patch.jsonlocally.npx frontend-auto-cms doctor- quick installation check.npm run publish:npm- publishfrontend-auto-cmsto npmjs.org.npm run publish:github- publish@gabo-tech/frontend-auto-cmsto GitHub Packages.npm run publish:dual- publish to npmjs.org and GitHub Packages in sequence.
Dual publish
Use dual publish if you want:
- public npm install from npmjs.org (
frontend-auto-cms) - mirrored package on GitHub Packages (
@gabo-tech/frontend-auto-cms)
One-time auth setup
# npmjs.org login
npm login
# GitHub Packages login (classic PAT required)
npm login --scope=@gabo-tech --auth-type=legacy --registry=https://npm.pkg.github.comPublish both registries
npm version patch
npm run build
npm run publish:dualGitHub Packages npm registry reference: Working with the npm registry.
Security note
The runtime passcode gate is lightweight and intended for editor access control in frontend environments. Enter provider token manually during publish; it is not persisted in config files. Prefer short-lived, repo-scoped tokens.
