https://github.com/doobie-droid/product-management-app
This is an assessment for Pay4Me.app to build a crud application using filament, with some unit tests and documentation to be done using Laravel Scribe
https://github.com/doobie-droid/product-management-app
filamentphp laravel pay4me pestphp scribe-api-documentation
Last synced: about 1 month ago
JSON representation
This is an assessment for Pay4Me.app to build a crud application using filament, with some unit tests and documentation to be done using Laravel Scribe
- Host: GitHub
- URL: https://github.com/doobie-droid/product-management-app
- Owner: doobie-droid
- Created: 2025-03-26T10:12:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-13T18:54:32.000Z (about 1 year ago)
- Last Synced: 2025-07-24T00:35:50.897Z (11 months ago)
- Topics: filamentphp, laravel, pay4me, pestphp, scribe-api-documentation
- Language: PHP
- Homepage: https://pay4me.laravel.cloud/
- Size: 395 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Product Management App
Submission for Pay4me assessment, includes CRUD application via FilamentPHP, Testing with PestPHP and doc generation with Laravel Scribe
The app has been hosted https://pay4me.laravel.cloud
You can visit the admin panel [here][hosted-url-admin]
### LOGIN DETAILS
| User Type | Email | Password |
| --------- | ----------------- | -------- |
| Admin | admin@example.com | password |
| Non-Admin | user@example.com | password |
### LOCAL SETUP
1. clone repository
2. copy .env.example file to .env and also to .env.testing file. Go to [Configuration](#configuration) to set DB details
```
cp .env.example .env && cp .env.example .env.testing
```
3. Download Dependencies
```
composer install
```
4. Set encryption key
```
php artisan key:generate
```
5. Perform migrations and seed database and migrate db for testing database
```
php artisan migrate --seed && php artisan migrate --env=testing
```
### DOCUMENTATION
1. To generate the documentation, you can run
```
php artisan scribe:generate
```
2. You can visit the documentation at [/docs][documentation-link]
### TESTING
1. After setting up, you can run the tests by running:
```
php artisan test
```
2. To see code coverage for the tests, install [xdebug][xdebug-url] and then run
```
php artisan test --coverage
```
### configuration
Please modify these values in the `.env` file.
- DB_DATABASE=product_db
- DB_PASSWORD=**\*\*\*\*** (Put your password here, leave blank if your mysql root uses no password)
Please modify these values in the `.env.testing` file.
- DB_DATABASE=product_db_testing
- DB_PASSWORD=**\*\*\*\*** (Put your password here, leave blank if your mysql root uses no password)
[xdebug-url]: https://xdebug.org/docs/install
[hosted-url-admin]: https://pay4me.laravel.cloud/admin
[documentation-link]: https://pay4me.laravel.cloud/docs