Skip to content

Commit adc8484

Browse files
bambamboolebambamboole
committed
git init
0 parents  commit adc8484

36 files changed

+1703
-0
lines changed

‎.ai/guidelines/xentral-testing.blade.php‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Testing conventions
2+
3+
- Check the project conventions to use whether PHPUnit or Pest
4+
- Prefer database backed integration tests over unit tests.
5+
- Each Eloquent model has to have a fully configured DatabaseFactory for a easier way of testing implementations.
6+
- Enrich factories with modifiers to enable easy customisations.
7+
- Each endpoint needs to have a PHPUnit test class with at least the following tests:
8+
- Request without token
9+
- Request with token but missing scopes (scopes are defined in config/token_scopes.php)
10+
- Includes
11+
- Filters on list endpoints
12+
- Validation Rules on endpoints with request body
13+
14+
- Each endpoint test class needs to have a Behat feature file with at least one test
15+
- Each Endpoint test class needs to have OpenAPI check on by default via the ValidatesOpenApiSpec trait.
16+
- Each Endpoint test class needs to have OpenAPI schema file defined via the SchemaFile attribute.
17+
- Faker: Use methods such as `$this->faker->word()` or `fake()->randomDigit()`. Follow existing conventions whether to use `$this->faker` or `fake()`.
18+
- When asked to write tests, check the diff of how code was changed, then update the tests accordingly and write new tests if needed to cover new functionality.
19+
- Use #[DataProvider] attributes for data-driven tests.
20+
- Define array keys in data providers instead of inline comments.

‎.claude/settings.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"enabledMcpjsonServers": [
3+
"laravel-boost"
4+
],
5+
"enableAllProjectMcpServers": true,
6+
"model": "anthropic.claude-sonnet-4-20250514-v1:0",
7+
8+
"env": {
9+
"CLAUDE_CODE_USE_BEDROCK": "1",
10+
"AWS_REGION": "eu-central-1",
11+
"MAX_THINKING_TOKENS": "1024",
12+
"CLAUDE_CODE_MAX_OUTPUT_TOKENS": "4096",
13+
"ANTHROPIC_MODEL": "eu.anthropic.claude-sonnet-4-20250514-v1:0"
14+
}
15+
}

‎.claude/settings.local.dist.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"env": {
3+
"AWS_BEARER_TOKEN_BEDROCK": "<CHANGEME>"
4+
},
5+
"permissions": {
6+
"defaultMode": "acceptEdits"
7+
},
8+
"enableAllProjectMcpServers": true,
9+
"enabledMcpjsonServers": [
10+
"laravel-boost"
11+
]
12+
}

‎.gitattributes‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
* text=auto
2+
3+
/.github export-ignore
4+
/.junie export-ignore
5+
/.claude export-ignore
6+
/tests export-ignore
7+
.gitattributes export-ignore
8+
.gitignore export-ignore
9+
.mcp.json export-ignore
10+
artisan export-ignore
11+
CLAUDE.md export-ignore
12+
phpstan.neon.dist export-ignore
13+
phpstan-baseline.neon export-ignore
14+
phpunit.xml export-ignore
15+
pint.json export-ignore
16+
rector.php export-ignore

‎.github/workflows/lint.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Lint
2+
3+
on:
4+
push:
5+
6+
jobs:
7+
pint:
8+
runs-on: ubuntu-latest
9+
permissions:
10+
contents: write
11+
steps:
12+
- uses: actions/checkout@v4
13+
- name: Setup PHP
14+
uses: shivammathur/setup-php@v2
15+
with:
16+
php-version: 8.2
17+
- name: Install dependencies
18+
run: composer install
19+
- name: Run laravel pint and rector
20+
run: composer lint
21+
- uses: stefanzweifel/git-auto-commit-action@v4
22+
with:
23+
commit_message: Apply pint changes

‎.github/workflows/main.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: run-tests
2+
3+
on: [push, pull_request]
4+
5+
6+
jobs:
7+
test:
8+
runs-on: ubuntu-latest
9+
name: PHP 8.2 test
10+
steps:
11+
- name: Checkout code
12+
uses: actions/checkout@v4
13+
- name: Setup PHP
14+
uses: shivammathur/setup-php@v2
15+
with:
16+
php-version: 8.2
17+
coverage: xdebug
18+
- name: Install dependencies
19+
run: |
20+
composer install
21+
- name: Execute phpstan
22+
run: composer phpstan:analyse
23+
- name: Execute tests
24+
run: composer test:ci

‎.gitignore‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
build
2+
composer.lock
3+
vendor
4+
.php_cs.cache
5+
coverage
6+
.phpunit.cache
7+
.phpunit.result.cache
8+
/.idea
9+
.php-cs-fixer.cache
10+
qase.config.json

‎CONTRIBUTING.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
Please read and understand the contribution guide before creating an issue or pull request.
6+
7+
## Etiquette
8+
9+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10+
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11+
extremely unfair for them to suffer abuse or anger for their hard work.
12+
13+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14+
world that developers are civilized and selfless people.
15+
16+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17+
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
18+
19+
## Viability
20+
21+
When requesting or submitting new features, first consider whether it might be useful to others. Open
22+
source projects are used by many developers, who may have entirely different needs to your own. Think about
23+
whether or not your feature is likely to be used by other users of the project.
24+
25+
## Procedure
26+
27+
Before filing an issue:
28+
29+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30+
- Check to make sure your feature suggestion isn't already present within the project.
31+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32+
- Check the pull requests tab to ensure that the feature isn't already in progress.
33+
34+
Before submitting a pull request:
35+
36+
- Check the codebase to ensure that your feature doesn't already exist.
37+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38+
39+
## Requirements
40+
41+
If the project maintainer has any additional requirements, you will find them listed here.
42+
43+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
44+
45+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
46+
47+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
48+
49+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
50+
51+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52+
53+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
54+
55+
**Happy coding**!

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) Xentral ERP Software GmbH
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Laravel Docs
2+
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/xentral/laravel-docs.svg?style=flat-square)](https://packagist.org/packages/xentral/laravel-docs)
4+
[![Total Downloads](https://img.shields.io/packagist/dt/xentral/laravel-docs.svg?style=flat-square)](https://packagist.org/packages/xentral/laravel-docs)
5+
![GitHub Actions](https://github.com/xentral/laravel-docs/actions/workflows/main.yml/badge.svg)
6+
7+
This package provides comprehensive documentation tools for Laravel applications, including phpdoc extraction and a
8+
MKDocs build process
9+
10+
## Installation
11+
12+
You can install the package via composer.
13+
14+
```bash
15+
composer --dev require xentral/laravel-docs
16+
```
17+
18+
## Usage
19+
20+
### Testing
21+
22+
```bash
23+
composer test
24+
```
25+
26+
## Contributing
27+
28+
### Ideas/Roadmap
29+
30+
TBD
31+
32+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
33+
34+
### Security
35+
36+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
37+
38+
## Credits
39+
40+
- [Manuel Christlieb](https://github.com/bambamboole)
41+
- [All Contributors](../../contributors)
42+
43+
## License
44+
45+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 commit comments

Comments
 (0)