create-quesby
v0.1.0
Published
Scaffold a new Quesby Boilerplate project
Maintainers
Readme
create-quesby
Scaffold a new Quesby Boilerplate project with a single command.
Installation
No installation needed! Use npx to run it directly:
npx create-quesby my-siteUsage
npx create-quesby <project-name>Example
npx create-quesby my-blogThis will create a new directory called my-blog with a fresh Quesby Boilerplate project.
What Gets Generated
The CLI creates a new project based on @quesby/boilerplate npm package, including:
- Complete Eleventy configuration
- Quesby Core integration
- Theme system with included themes
- Content structure (posts, pages, documentation)
- Admin CMS configuration (Decap CMS)
- Build scripts and development tools
- All necessary templates and assets
Requirements
- Node.js: >= 18.0.0
- Package Manager: pnpm (recommended) or npm
Next Steps
After creating your project:
cd my-site
pnpm install
pnpm serveVisit http://localhost:8080 to see your site.
What Gets Skipped
The following files/directories are excluded from the template:
node_modules/- Dependencies (you'll install fresh).git/- Git history (you'll initialize your own)_site/- Build output- Lock files (
pnpm-lock.yaml,package-lock.json, etc.) - Environment files (
.env) - IDE/editor configs (
.vscode/,.idea/, etc.)
How It Works
- Resolves the
@quesby/boilerplatenpm package fromnode_modules - Copies all template files to your new project directory
- Updates
package.jsonwith your project name - Cleans up template-specific metadata
License
MIT
