Skip to content

Commit

Permalink
chore: add placeholders for cookiecutter
Browse files Browse the repository at this point in the history
  • Loading branch information
geoffreyvanwyk committed Aug 6, 2024
1 parent 65fc120 commit 578a162
Show file tree
Hide file tree
Showing 7 changed files with 127 additions and 7,934 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/continuous-integration.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,29 @@
---
# This file is part of package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}.
#
# Package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }} is free software: you can redistribute it
# and/or modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }} is distributed in the hope that it will be
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
# Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}. If not, see <https://www.gnu.org/licenses/>.

##
# GitHub Actions workflow that lints and tests new code before its integration
# into the master branch of the source code repository.
#
# @see {@link https://docs.github.com/en/actions} GitHub Actions
# @author {{ cookiecutter.author_name }} <{{ cookiecutter.author_email }}>
# @copyright {% now 'utc', '%Y' %} {{ cookiecutter.author_name }} {@link {{ cookiecutter.author_website }}}
# @license {@link http://www.gnu.org/copyleft/gpl.html} GNU GPL v3 or later
##

name: Continous Integration

on:
Expand Down
80 changes: 29 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,44 @@
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
![Repository Banner]("https://banners.beyondco.de/{{ cookiecutter.package_title }}.png?theme=light&packageManager=composer+require&packageName={{ cookiecutter.vendor_name }}%2F{{ cookiecutter.package_name }}&pattern=circuitBoard&style=style_1&description={{ cookiecutter.package_description }}&md=1&showWatermark=1&fontSize=100px&images=https%3A%2F%2Flaravel.com%2Fimg%2Flogomark.min.svg")

<p align="center">
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
</p>
[![Latest Version on Packagist]("https://img.shields.io/packagist/v/{{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}.svg?style=flat-square")]("https://packagist.org/packages/{{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}")
[![Total Downloads](https://img.shields.io/packagist/dt/{{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}.svg?style=flat-square)]("https://packagist.org/packages/{{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}")
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/{{ cookiecutter.github_username }}/{{ cookiecutter.github_repository }}/continuous-integration.yml?branch=master&label=tests&style=flat-square)]("https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.github_repository }}/actions?query=workflow%3Acontinuous-integration+branch%3Amaster")
[![PHPUnit Code Coverage]("https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.github_repository }}/blob/image-data/coverage.svg")]("https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.github_repository }}/actions?query=workflow%3Acontinuous-integration+branch%3Amaster")

## About Laravel
# {{ cookiecutter.package_title }}

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
{{ cookiecutter.package_description }}

- [Simple, fast routing engine](https://laravel.com/docs/routing).
- [Powerful dependency injection container](https://laravel.com/docs/container).
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
- [Robust background job processing](https://laravel.com/docs/queues).
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
## Install

Laravel is accessible, powerful, and provides tools required for large, robust applications.
Use [Composer](https://getcomposer.org) to install the package.

## Learning Laravel
```shell
composer require {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}
```

Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
## Usage

You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
> [!NOTE]
> Explain how to use the package.
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.

## Laravel Sponsors

We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).

### Premium Partners

- **[Vehikl](https://vehikl.com/)**
- **[Tighten Co.](https://tighten.co)**
- **[WebReinvent](https://webreinvent.com/)**
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
- **[64 Robots](https://64robots.com)**
- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
- **[Cyber-Duck](https://cyber-duck.co.uk)**
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
- **[Jump24](https://jump24.co.uk)**
- **[Redberry](https://redberry.international/laravel/)**
- **[Active Logic](https://activelogic.com)**
- **[byte5](https://byte5.de)**
- **[OP.GG](https://op.gg)**

## Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
## License

## Code of Conduct
Copyright &copy; {% now 'utc', '%Y' %} {{ cookiecutter.author_name }} [{{ cookiecutter.author_website }}]({{ cookiecutter.author_website }})

In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
This file is part of package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}.

## Security Vulnerabilities
Package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }} is free software: you can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
Package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }} is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.

## License
You should have received a copy of the GNU General Public License along with
package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}. If not, see <https://www.gnu.org/licenses/>.

The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
For a copy of the license, see the [LICENSE](LICENSE) file in this repository.
23 changes: 23 additions & 0 deletions bootstrap/app.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
<?php

// This file is part of package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}.
//
// Package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }} is free software: you can redistribute it
// and/or modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }} is distributed in the hope that it will be
// useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
// Public License for more details.
//
// You should have received a copy of the GNU General Public License along with
// package {{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}. If not, see <https://www.gnu.org/licenses/>.

/**
* Bootstrap the Laravel services to use during development of the package.
*
* @author {{ cookiecutter.author_name }} <{{ cookiecutter.author_email }}>
* @copyright {% now 'utc', '%Y' %} {{ cookiecutter.author_name }} {@link {{ cookiecutter.author_website }}}
* @license {@link http://www.gnu.org/copyleft/gpl.html} GNU GPL v3 or later
*/

use Illuminate\Foundation\Application;
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Foundation\Configuration\Middleware;
Expand Down
8 changes: 4 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "vendor/package",
"name": "{{ cookiecutter.vendor_name }}/{{ cookiecutter.package_name }}",
"type": "library",
"description": "The skeleton package for the Laravel framework.",
"description": "{{ cookiecutter.package_description }}",
"keywords": [
"laravel",
"package"
Expand All @@ -24,12 +24,12 @@
},
"autoload": {
"psr-4": {
"App\\": "app/"
"{{ cookiecutter.php_namespace }}\\": "app/"
}
},
"autoload-dev": {
"psr-4": {
"Tests\\": "tests/"
"{{ cookiecutter.php_namespace }}\\Tests\\": "tests/"
}
},
"scripts": {
Expand Down
Loading

0 comments on commit 578a162

Please sign in to comment.