• About Laradev React
• Features
• Tech Stack
• Installation - Local Development
• Changelog
• Contributing
  • PHP code style - Laravel Pint
  • Running tests
  • Code Scanning
  • Git Hooks
• Available Scripts
• Available Scripts - DDEV
• Releasing a new version
• Security
• License
• Credits

Laradev-React is a sample Laravel app that can be used as a skeleton for your next Laravel project.

It includes a basic setup for both the backend and frontend, with support for both DDEV and Native (PHP, Composer, etc running locally) development environments.

1. Support for both DDEV and Native development environments
2. React.js/Inertia frontend with Vite for faster development
3. Tailwind CSS with shadcn/ui components
4. SCSS support with PostCSS
5. TypeScript support
6. Automated code formatting (PHP, JS/TS, SCSS)
7. Git hooks for code quality
8. Comprehensive test suite using Pest
9. Role-based authentication using Spatie Permissions
10. Dark mode support
11. Responsive design
12. GitHub Actions for CI/CD

• Backend:

  • Laravel 11.x
  • PHP 8.3+
  • MySQL/SQLite
  • Laravel Pint (Code Styling)
  • PHPStan (Static Analysis)
  • Pest (Testing)

• Frontend:

  • React 19
  • TypeScript
  • Tailwind CSS
  • shadcn/ui Components
  • Vite
  • ESLint + Prettier

In order to start developing with Laradev, you will need to read the guide in the LOCAL-DEVELOPMENT.md file.

Please see CHANGELOG for more information on what has changed recently.

To contribute to the application, follow these steps:

1. Fork this repository.
2. Read the CONTRIBUTING file.
3. Create a branch: git checkout -b <branch_name>.
4. Make your changes and commit them: git commit -m '<commit_message>'
5. Push to the original branch: git push origin <project_name>/<location>
6. Create the pull request

This application uses Laravel Pint in order to perform code-styling checks and fixes.

In order to run the styler, run :

./vendor/bin/pint --test -v # the --test will not do any changes, it will just output the changes needed

./vendor/bin/pint -v # this command will actually perform the code style changes

To run the tests, run the following command:

./vendor/bin/pest

Or, under DDEV:

ddev test

To run the tests with coverage, run the following command:

XDEBUG_MODE=coverage ./vendor/bin/pest --coverage

To filter tests, use the --filter flag. For example:

./vendor/bin/pest --filter testName

This application uses PHPStan in order to perform code-scanning checks.

In order to run the code-scanner, run the following command:

./vendor/bin/phpstan analyse

The project includes pre-commit hooks that automatically format code. They're installed automatically with:

composer install

• npm run dev - Start Vite development server
• npm run build - Build for production
• npm run lint - Run ESLint
• npm run lint:fix - Fix ESLint issues
• npm run types - Check TypeScript types
• composer format - Format PHP code
• composer analyse - Run static analysis

• ddev artisan migrate - Migrate the database
• ddev artisan db:seed - Seed the database
• ddev artisan db:refresh - Refresh the database
• ddev artisan db:reset - Reset the database
• ddev artisan key:generate - Generate the application key
• ddev artisan migrate:fresh - Refresh the database and migrate
• ddev artisan migrate:fresh --seed - Refresh the database and seed
• ddev artisan migrate:fresh --seed --seeder=DatabaseSeeder - Refresh the database and seed with the DatabaseSeeder
• ddev pint - Format PHP code
• ddev test - Run tests
• ddev analyse - Run static analysis
• ddev format - Format all code

After you have committed your changes, create a new git tag:

git tag -a vx.y.z -m "This is a nice tag name"

(for the x.y.z version number, follow the Semantic Versioning guidelines).

Then, push the tag:

git push origin vx.y.z

Then, in the GitHub Releases page, create a new Release * and correlate it with the tag that you just created.*

Also, don't forget to update the CHANGELOG.md file with the new version name, release date, and release notes.

If you discover any security-related issues, please email info[at]scify.org, instead of using the issue tracker.

This project is open-sourced software licensed under the Apache License, Version 2.0.

• SciFY This project is developed and maintained by SciFY and is based on the Laravel framework.