README.md

Generic project scaffold template

📘 Scaffold documentation

Features

• Shell
  • Simple single-file script scaffold with BATS tests (with coverage)
  • CI config to Lint and test (with coverage)
• PHP
  • composer.json
  • Symfony CLI command app scaffold with unit tests (with coverage) and traits
  • Simple single-file script scaffold with unit tests (with coverage)
  • Code quality tools with configurations: PHP Code Sniffer, PHPStan, Rector
  • CI config to Lint, test and publish PHP as PHAR
• NodeJS
  • package.json
  • CI config to build and test and test for NodeJS
• CI
  • Release drafter
  • Release asset packaging and upload
  • PR auto-assign
• Documentation
  • Readme with badges and generated logo
  • Scaffold for the documentation site using Docusaurus
  • Spell check with CSpell
  • Terminalizer configuration file
• Utility files
  • .editorconfig, .gitignore, .gitattributes
  • Renovate bot configuration
  • Pull request template
  • Funding
  • Init shell script to chose features

How to use this scaffold repository

1. Click on Use this template > Create a new repository
2. Checkout locally
3. Run ./init.sh to replace yournamespace, yourproject, Your Name strings with your own and choose the features.