Pikari Development Environment Setup

A comprehensive tool for setting up consistent development environments across projects. This tool goes beyond just linting to provide a complete development environment including pre-commit hooks, CI/CD workflows, and project-specific configurations.

🚀 Quick Start

# Navigate to your project directory
cd your-project

# Clone the setup tool
git clone https://github.com/HelloPikari/pikari-dev-setup.git

# Run the setup
./pikari-dev-setup/setup.sh

📋 What's Included

WordPress Environment

• Linting Configuration

  • ESLint with WordPress standards
  • Stylelint for CSS/SCSS
  • PHPCS with WordPress coding standards
  • Prettier for consistent formatting

• Pre-commit Hooks

  • Husky + lint-staged
  • Automatic linting on commit

• GitHub Workflows

  • CI workflow for tests and linting
  • Build branch automation
  • Release automation

• WordPress Playground

  • Local development blueprint
  • Demo blueprint for GitHub

• Release Automation

  • Release Drafter for automated changelogs
  • GitHub Releases with assets
  • Composer distribution via dist branch

• CLAUDE.md

  • AI assistant context
  • Project-specific guidelines
  • Coding standards documentation

🏗️ Project Structure

pikari-dev-setup/
├── setup.sh              # Main entry point
├── shared/               # Shared components
│   ├── husky/           # Generic pre-commit hooks
│   └── claude/          # Base CLAUDE.md templates
└── wordpress/           # WordPress-specific setup
    ├── setup.sh         # WordPress setup script
    ├── linting/         # Linting configurations
    ├── github/          # GitHub workflows and configs
    ├── playground/      # WordPress Playground configs
    ├── claude/          # WordPress CLAUDE.md templates
    └── package-scripts/ # npm/composer scripts

🔧 Usage

Initial Setup

1. From your project root, run the setup script:

   ./pikari-dev-setup/setup.sh

2. Select your project type (currently WordPress only)

3. Provide project information when prompted:

   • Project name and description
   • Author name and email
   • Project homepage (optional)

4. Follow the prompts to:

   • Copy configuration files
   • Set up pre-commit hooks
   • Create GitHub workflows
   • Generate CLAUDE.md
   • Create/update package.json and composer.json

5. The setup will offer to:

   • Install npm dependencies
   • Install composer dependencies
   • Remove the setup folder when complete

After Setup

Run linting:

npm run lint:all     # Run all linters
npm run lint:fix     # Auto-fix issues

Start development:

npm start            # Start dev build
npm run playground   # Launch WordPress Playground

Create a release:

# 1. Merge PR to main branch
# 2. Publish the draft release on GitHub  
# 3. Assets and dist branch are created automatically

🛠️ Customization

Adding New Project Types

1. Create a new directory under pikari-dev-setup/:

   mkdir react

2. Add project-specific components:

   • setup.sh - Setup script
   • Linting configurations
   • Tool configurations
   • Templates

3. Update main setup.sh to include the new option

Modifying Shared Components

Shared components in the shared/ directory can be used across all project types:

• Husky configurations
• Base CLAUDE.md sections
• Common workflows

📝 Requirements

• Node.js 16+ (for JavaScript tooling)
• PHP 8.2+ (for WordPress projects)
• Composer (for PHP dependencies)
• jq (for JSON manipulation in scripts)
• Git (for version control)

🤝 Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

Adding a New Configuration

1. Create a new directory under pikari-dev-setup/
2. Add all necessary config files and setup script
3. Create comprehensive documentation
4. Update the main setup.sh to include your configuration
5. Submit a pull request

📄 License

MIT - Feel free to use and modify these configurations for your projects.

🙏 Acknowledgments

Built with inspiration from various open-source projects and the WordPress community.