https://github.com/greg-1-anderson/starter-test-32

https://github.com/greg-1-anderson/starter-test-32

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/greg-1-anderson/starter-test-32
• Owner: greg-1-anderson
• License: mit
• Created: 2018-04-05T04:06:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-04-05T04:22:19.000Z (over 6 years ago)
• Last Synced: 2024-10-26T06:11:01.161Z (2 months ago)
• Language: Shell
• Size: 21.5 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Starter

A starter PHP project with many services and features pre-configured. Simply use `composer create-project`, and a new GitHub repository will be created and configured to be tested on Travis CI.

## Usage

To get started, export your [GitHub personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) and then create a new project.

```

$ export GITHUB_TOKEN='[REDACTED]'

$ composer create-project greg-1-anderson/starter-test-32 my-new-project

```

The new project will be owned by the currently-authenticated user. If you would like to create a new project in an organization instead, then set the `GITHUB_ORG` environment variable.

```

$ export GITHUB_ORG='my-github-username-or-org'

```

## Features

This project comes with a number of configuration files already set up for a number of services. A Composer post-install hook makes further modifications, and, where possible, makes API calls to complete the setup for some services.

The following things are provided:

- Project information

  - [composer.json](/composer.json): Automatically customized with project-specific information.

    - Project name (taken from `create-project` project name argument)

    - Author name and email address (from git configuration)

  - [README.md](/customize/templates/README.md): Example template with badges to get you started.

  - [CHANGELOG.md](/CHANGELOG.md): Blank slate provided in the hopes that releases may be recorded here.

  - [LICENSE](/LICENSE): Defaults to MIT. Will automatically be updated with dependency licenses and copyright year every time 'composer update' is run.

- Project metadata

  - [.editorconfig](/.editorconfig): Set up for PSR-2 conventions for compliant editors.

  - [.gitattributes](/.gitattributes): Ensures that tests, build results and so on are not exported to Packagist.

  - [.gitignore](/.gitignore): Ensures that vendor directory and so on is not committed to the repository.

- Repository

  - **GitHub:** Automatically creates a new repository on GitHub and pushes up your new project. Starter GitHub contribution templates are provided:

    - [CONTRIBUTING.md](/CONTRIBUTING.md)

    - [issue_template.md](/.github/issue_template.md)

    - [pull_request_template](/.github/pull_request_template.md)    

- Testing

  - **Travis:** Automatically enables testing for the new project in Travis.

    - [phpunit.xml.dist](/phpunit.xml.dist): Test configuration with code coverage (html coverage report configuration is present, but commented out).

    - [Example.php](/src/Example.php): A simple class that multiplies. Replace with your own code.

    - [ExampleTest.php](/tests/ExampleTest.php): A simple data-driven test that pulls fixture data from a data provider. Replace with your own tests.

  - **Coveralls:** Project must be manually configured on [coveralls.io](https://coveralls.io). PHPUnit and Travis are already configured to export coverage data to Coveralls automatically.

  - **Appveyor:** An appveyor configuration file is provided, but project must be manually enabled on [appveyor](https://www.appveyor.com/) if Windows testing is desired.

  - **Scrutinizer:** Project must be manually enabled on [scrutinizer-ci.com](https://scrutinizer-ci.com).

  - Provides handy composer scripts:

    - `composer test`: Run all tests.

    - `composer unit`: Run just the phpunit tests.

    - `composer lint`: Run the php linter.

    - `composer cs`: Run the code sniffer to check for PSR-2 compliance.

    - `composer cbf`: Fix code style violations where possible.

- Composer

  - **Packagist:** Project must be manually submitted to [packagist.org](https://packagist.org)

  - **Dependencies:** A [dependencies.yml](/dependencies.yml) is provided; project must be enabled on [dependencies.io](https://www.dependencies.io/)

  - [Composer test scenarios](https://github.com/g-1-a/composer-test-scenarios) are configured to allow tests to be written for PHPUnit 6, and still use PHPUnit 5 for testing on PHP 5.6. Highest/lowest testing is also configured by default.

After the `composer create-project` completes running, your new project will exist on GitHub, and the first test (with placeholder code) should already be queued to run on Travis. Run through the list above, customize as needed, enable services that were not automatically configured, and start writing your own code.