Skip to content

Commit a1ff6b3

Browse files
Copilotnielsdrost7
andauthored
Add tech stack, dev commands, and documentation refs to Copilot instructions (#116)
* Initial plan * docs: enhance copilot instructions with tech stack and dev commands Co-authored-by: nielsdrost7 <47660417+nielsdrost7@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: nielsdrost7 <47660417+nielsdrost7@users.noreply.github.com>
1 parent c9f56c6 commit a1ff6b3

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

.github/copilot-instructions.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,61 @@ This project is **InvoicePlane v2**, a **multi-tenant Laravel application** with
1212
- Tests for each module are located in:
1313
`/Modules/(ModuleName)/Tests`
1414

15+
## Tech Stack
16+
17+
- **Backend:** Laravel 12+ (PHP 8.2+)
18+
- **UI Framework:** Filament 4.0
19+
- **Frontend:** Livewire, Tailwind CSS
20+
- **Testing:** PHPUnit 11+
21+
- **Code Quality:** Laravel Pint (PSR-12), PHPStan, Rector
22+
- **Module System:** nwidart/laravel-modules
23+
- **Permissions:** spatie/laravel-permission
24+
- **Multi-tenancy:** Filament Companies with `BelongsToCompany` trait
25+
26+
## Development Commands
27+
28+
### Testing
29+
```bash
30+
# Run all tests
31+
php artisan test
32+
33+
# Run tests with coverage
34+
php artisan test --coverage
35+
36+
# Run specific test suite
37+
php artisan test --testsuite=Unit
38+
php artisan test --testsuite=Feature
39+
```
40+
41+
### Code Quality
42+
```bash
43+
# Format code with Laravel Pint
44+
vendor/bin/pint
45+
46+
# Run static analysis
47+
vendor/bin/phpstan analyse
48+
49+
# Run Rector for automated refactoring
50+
vendor/bin/rector process --dry-run
51+
```
52+
53+
### Setup & Installation
54+
```bash
55+
# See .github/INSTALLATION.md for detailed setup
56+
composer install
57+
cp .env.example .env
58+
php artisan key:generate
59+
php artisan migrate --seed
60+
```
61+
62+
## Related Documentation
63+
64+
- **Installation:** `.github/INSTALLATION.md`
65+
- **Contributing:** `.github/CONTRIBUTING.md`
66+
- **Seeding:** `.github/SEEDING.md`
67+
- **Testing:** See test examples in `Modules/*/Tests/`
68+
- **Commit Conventions:** `.github/git-commit-instructions.md`
69+
1570
## Guidelines
1671

1772
- **SOLID Principles** must be followed at all times.

0 commit comments

Comments
 (0)