/scaffold

Generic project scaffold template

Primary LanguageShellGNU General Public License v3.0GPL-3.0

Scaffold logo

Generic project scaffold template
GitHub Issues GitHub Pull Requests Scaffold test codecov Scaffold LICENSE GitHub Scaffold release (latest by date) Renovate
Features

- PHP
    - composer.json config
    - Symfony CLI command app scaffold with unit tests (with coverage) and traits
    - Simple single-file script scaffold with unit tests (with coverage) and traits
    - Code quality tools with configurations: PHP Code Sniffer, PHP Mess Detector, PHPStan
- NodeJS
    - package.json config
- CI
    - Lint, test and publish PHP as PHAR
    - Build and test for NodeJS
    - Release drafter
    - Release asset packaging and upload
    - PR auto-assign
    - Funding
- Utility files
    - Readme with badges
    - .editorconfig, .gitignore, .gitattributes
    - 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.
init
This table will be removed after running ./init.sh.

Yourproject logo

yourproject

GitHub Issues GitHub Pull Requests Test PHP Test Node.js codecov GitHub release (latest by date) LICENSE Renovate


Few lines describing your project.

Features

  • Your first feature as a list item
  • Your second feature as a list item
  • Your third feature as a list item

Installation

composer require yournamespace/yourproject
npm install @yournamespace/yourproject

Usage

vendor/bin/yourproject
node_modules/.bin/yourproject

Maintenance

composer install
composer lint
composer test
npm install
npm run lint
npm run test