An open API service indexing awesome lists of open source software.

https://github.com/milan-miscevic/php-skeleton

Starting point for other PHP projects
https://github.com/milan-miscevic/php-skeleton

php-project php-template skeleton skeleton-application template template-application

Last synced: 12 months ago
JSON representation

Starting point for other PHP projects

Awesome Lists containing this project

README

          

# php-skeleton

[![Software License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![PDS Skeleton](https://img.shields.io/badge/pds-skeleton-blue.svg?style=flat-square)](https://github.com/php-pds/skeleton)

[![GitHub Build](https://github.com/milan-miscevic/php-skeleton/workflows/Test/badge.svg?branch=master)](https://github.com/milan-miscevic/php-skeleton/actions)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=milan-miscevic_php-skeleton&metric=alert_status)](https://sonarcloud.io/dashboard?id=milan-miscevic_php-skeleton)
[![Type Coverage](https://shepherd.dev/github/milan-miscevic/php-skeleton/coverage.svg)](https://shepherd.dev/github/milan-miscevic/php-skeleton)
[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fmilan-miscevic%2Fphp-skeleton%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/milan-miscevic/php-skeleton/master)

This repository provides a starting point for other PHP projects.

## Installation

1. Create a new project based on this GitHub template.
1. Clone the project.
1. Update the `composer.json` data:
* `name`
* `description`
* `type` (in library)
* `keywords`
* `require.php` (in project)
* `autoload.psr-4` (the project namespace)
* `autoload-dev.psr-4` (the project namespace)
1. Remove unnecessary folders.
1. Search for the `@todo` tag and make changes.
1. Update the `README.md` file.
1. Make other needed adjustments.
1. Commit & push.
1. Continue work on the new project.

## Usage

For available commands check [Makefile](Makefile).