https://github.com/alexskrypnyk/scaffold

Generic project scaffold template
https://github.com/alexskrypnyk/scaffold

actions ci cli cli-template commandline composer documentation github kick-start nodejs php phpunit project-template scaffold scaffold-template skeleton starter-kit template

Last synced: 2 months ago
JSON representation

Generic project scaffold template

• Host: GitHub
• URL: https://github.com/alexskrypnyk/scaffold
• Owner: AlexSkrypnyk
• License: gpl-3.0
• Created: 2023-03-20T22:03:05.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-18T16:03:36.000Z (2 months ago)
• Last Synced: 2024-10-19T00:02:21.190Z (2 months ago)
• Topics: actions, ci, cli, cli-template, commandline, composer, documentation, github, kick-start, nodejs, php, phpunit, project-template, scaffold, scaffold-template, skeleton, starter-kit, template
• Language: Shell
• Homepage: https://getscaffold.dev
• Size: 3.63 MB
• Stars: 7
• Watchers: 2
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.dist.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  

  



Few lines describing your project




[![GitHub Issues](https://img.shields.io/github/issues/AlexSkrypnyk/scaffold.svg)](https://github.com/AlexSkrypnyk/scaffold/issues)

[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/AlexSkrypnyk/scaffold.svg)](https://github.com/AlexSkrypnyk/scaffold/pulls)

[![Test PHP](https://github.com/AlexSkrypnyk/scaffold/actions/workflows/test-php.yml/badge.svg)](https://github.com/AlexSkrypnyk/scaffold/actions/workflows/test-php.yml)

[![Test Node.js](https://github.com/AlexSkrypnyk/scaffold/actions/workflows/test-nodejs.yml/badge.svg)](https://github.com/AlexSkrypnyk/scaffold/actions/workflows/test-nodejs.yml)

[![Test Shell](https://github.com/AlexSkrypnyk/scaffold/actions/workflows/test-shell.yml/badge.svg)](https://github.com/AlexSkrypnyk/scaffold/actions/workflows/test-shell.yml)

[![codecov](https://codecov.io/gh/AlexSkrypnyk/scaffold/graph/badge.svg?token=7WEB1IXBYT)](https://codecov.io/gh/AlexSkrypnyk/scaffold)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/AlexSkrypnyk/scaffold)

![LICENSE](https://img.shields.io/github/license/AlexSkrypnyk/scaffold)

![Renovate](https://img.shields.io/badge/renovate-enabled-green?logo=renovatebot)



---

## Features

- Your first feature as a list item

- Your second feature as a list item

- Your third feature as a list item

## Installation

[//]: # (#;< PHP)

    composer require yournamespace/yourproject

[//]: # (#;> PHP)

[//]: # (#;< NODEJS)

    npm install @yournamespace/yourproject

[//]: # (#;> NODEJS)

[//]: # (#;< SHELL)

Download the latest release from GitHub releases page.

[//]: # (#;> SHELL)

## Usage

[//]: # (#;< PHP)

    vendor/bin/yourproject

[//]: # (#;> PHP)

[//]: # (#;< NODEJS)

    node_modules/.bin/yourproject

[//]: # (#;> NODEJS)

[//]: # (#;< SHELL)

    ./shell-command.sh

[//]: # (#;> SHELL)

### CLI options

| Name        | Default value | Description                        |

|-------------|---------------|------------------------------------|

| `arg1`      |               | Description of the first argument. |

| `--option1` | `default1`    | Option with a default value.       |

| `--option2` | None          | Option wihtout a value.            |

## Maintenance

[//]: # (#;< PHP)

    composer install

    composer lint

    composer test

[//]: # (#;> PHP)

[//]: # (#;< NODEJS)

    npm install

    npm run lint

    npm run test

[//]: # (#;> NODEJS)

[//]: # (#;< SHELL)

    shellcheck shell-command.sh tests/bats/*.bash tests/bats/*.bats

    shfmt -i 2 -ci -s -d shell-command.sh tests/bats/*.bash tests/bats/*.bats

    npm ci --prefix tests/bats

    ./tests/bats/node_modules/.bin/bats tests/bats

[//]: # (#;> SHELL)

---

_This repository was created using the [Scaffold](https://getscaffold.dev/) project template_