A starter-kit for your PHP project.

medunes

Last update: Dec 17, 2022

Related tags

Build Tools php opensource php7 travis-ci continuous-integration continuous-delivery phpunit starter-template starter sonarqube continuous-testing skeleton-application starter-kit phpstan skeleton-template sonarcloud psalm github-actions

Overview

PHP Noise

A starter-kit for your PHP project. It includes frequently needed boilerplate setups (ci, badges, etc.)

📦 Installation

To install this application, first ensure you have Composer installed, then:

# Create your skeleton app (feel free to change the folder name instead of the demo one)
$ composer create-project medunes/noise-php my-demo-project

# Enter your app folder
$ cd my-demo-project

# Install dependencies
$ composer setup:clean

# Run the build script (tests, etc.)
$ composer build

ℹ️ FAQ

So what is this?

This is PHP Noise !

An empty skeleton, a list of ready to customize setups.

These setups are commonly used when publishing PHP opensource projects or libraries.

I use this skeleton as a basis when I start a new project on Github.

Instead of spending time setting up configs from scratch, I'd rather customize them.

More details?

Nowadays, you don't just write some "working" code and ship it to the community.

There are a couple of disciplines you should follow in order to have your library acceptable by the community (or by yourself :) )

For example, code quality, tests, README, Documentation, License, logo, CHANGELOG, CI and many others.

I call these requirement: noise, not in a pejorative way, but maybe because writing new code is more fun than spending time fixing, testing, validating or documenting it.

Which kind of noise?

Currently, we support the following noise, but feel free to increase the volume:

Where to go next?

Writing noise projects for other languages: Javascript, Go, C, C++, ..

You might also like...

Laravel API starter Kit will provide you with the tools for making API's that everyone will love

Comments

Make it possible to add the boilerplate noise on top of an existing project

There should be a possibility to add the boilerplate and test configs on top of an existing project, without having to do it the other way around, i.e create noise project and copy the existing one to it.
wontfix

opened by MedUnes 2
Add a command based solution to fill in placeholders
Add a command based solution customize the setup

tokens & keys

coverage

user identity: name, repo name, username, email, php version, license, etc.

choose which setups to keep/delete

wontfix
opened by MedUnes 0
the composer dependencies are not cached

the composer dependencies are not cached in the github workflow. it can be faster if they’re cached (example: https://github.com/markuspoerschke/iCal/blob/2.x/.github/workflows/ci.yml#L26-L34)

opened by MedUnes 0
Use a standardized changelog format

Use a standardized changelog format: https://keepachangelog.com/en/1.0.0/ It is easier to understand for the user of the package and there are even some github worklows that can automate updating the changelog file

opened by MedUnes 0

A starter-kit for your PHP project.

Related tags

Overview

PHP Noise

A starter-kit for your PHP project. It includes frequently needed boilerplate setups (ci, badges, etc.)

📦 Installation

ℹ️ FAQ

So what is this?

More details?

Which kind of noise?

Where to go next?

You might also like...

Laravel API starter Kit will provide you with the tools for making API's that everyone will love

Laravel starter kit with Livewire & Bootstrap 5 auth scaffolding.

A Laravel Starter Kit for Laravel. Built with Laravel 8.

Laravel + Livewire + Bootstrap 5 UI starter kit.

Laravel Livewire UI, Auth, & CRUD starter kit.

a free, open-source dashboard panel starter kit for Laravel

One click, Fully Decoupled Drupal Site starter-kit with Druxt

Starter-kit for running a Drupal 9 website with Tome in Gitpod

Starter-kit for running a Drupal 9 website in Gitpod

A simple starter kit for using TypedCMS with the Laravel framework.

🔪 WordPress + React Starter Kit: Spin up a WordPress-powered React app in one step

Laravel React Webpack Starter Kit

👔 Enterprise Web application starter kit or template using Laravel

Gallium is a TALL stack starter kit offering a robust set of options enabling you to get up and running in a snap.

A Laravel-Nuxt starter kit.

A Laravel-Vue-Tailwind SAAS Starter Kit.

A Laravel-Vue SPA starter kit.

A starter kit that integrates Laravel with Vue CLI, Inertia.js, TailwindCSS and Vuetify

An administration starter kit for Laravel.

Comments

Make it possible to add the boilerplate noise on top of an existing project

Add a command based solution to fill in placeholders

the composer dependencies are not cached

Use a standardized changelog format

Owner

medunes

A PHP project/micro-package generator for PDS compliant projects or micro-packages.

Danger runs during your CI process, and gives teams the chance to automate common code review chores.

GitHub action to setup PHP with required extensions, php.ini configuration, code-coverage support and various tools like composer...

Hi I'm Bob! I'm a tiny and messy build tool for PHP projects

remake of doxbin in php

Phpake is a make-like utility built for PHP.

Wave - The Software as a Service Starter Kit, designed to help you build the SAAS of your dreams 🚀 💰

Electrik is a full-featured, open-source, starter-kit to help you build you your SaaS application.

Jumpstart your web development journey with the HALT Stack Starter Kit, a one-command solution for creating dynamic, scalable, and clean web applications.

Dynamic Framework :: A PHP starter kit for Noobs