Project Template

A reusable project template with testing, linting, and deployment setup.

Features

• Modern JavaScript (ES6+) setup
• JSDOC type checking for simple code structure and AI iteration
• ESLint and Prettier for code quality
• Puppeteer for auto-testing
• Deployment scripts for CI/CD
• Health check utilities for AI iteration
• Documentation templates for AI guidance

Installation

You can use this template in two ways:

1. Use npx (no installation required)

npx create-vibes

2. Install globally

npm install -g create-vibes

Then create a new project in current directory: (or specify a different directory immediately after the command)

create-vibes

Usage

After creating a project from this template:

1. You don't need to install dependencies, they are already installed every time app is started.

2. After developing, start the project:

   npm start

3. Run tests (based on Puppeteer, optimal for frontend AI iteration):

   npm test

4. Lint and format code (based on ESLint and Prettier, optimal for AI iteration):

   npm run lint
   npm run format

5. Run type checking (based on JSDOC, optimal for AI iteration):

   npm run typecheck

6. Run health check:

   npm run healthcheck

Project Structure

.
├── docs/                 # Documentation files
├── scripts/              # Utility scripts
├── tests/                # Test files
│   └── test_output/      # Test output (screenshots, traces)
├── eslint.config.js      # ESLint configuration
├── main.js               # Main application entry point
├── package.json          # Project configuration
└── tsconfig.json         # TypeScript configuration

Updating the Template

When you make improvements to your workflow, you can update this template:

1. Make your changes
2. Update the version in package.json
3. Publish the new version:

   npm publish

License

ISC