Start PHP applications using Laravel preconfigured with TypeScript, Livewire, Alpine.js, TailwindCSS and many others such as Vite.js, Rome, Vitest, Pint, PHPStan, Larastan, Rector, etc.

• Sikessem Starter
  • 🔖 Contents
  • 🎉 Getting Started
    • ⚡️ Installation
    • 🗃️ Manage Database
    • 🌐 Starting server
    • 🧪 Testing and debugging
      • 🧹 Keep a modern codebase
      • ⚗️ Run static analysis
      • ✅ Run unit tests
      • 🐛 Check all code bugs
  • 📋 Requirements
  • 📖 Documentation
  • 👏 Contribution
    • 👷 Code of Conduct
    • 👥 Contributing Guide
    • 🔒️ Good First Issues
    • 💬 Discussions
  • 🔐 Security Reports
  • 📄 License

Use this template or create a new Sikessem project via the Composer create-project command (recommended):

composer create-project sikessem/starter --prefer-source my-app

Where my-app is the name of your app.

Access the working directory:

cd my-app 

Install PHP dependencies:

composer install

Install JS / TS dependencies:

pnpm install

🍱 Build assets

The production build will generate client and server modules by running both client and server build commands:

pnpm build

Install migrations:

php artisan migrate:install && php artisan migrate

Run the server in development mode:

php artisan serve --host=my-app.local --port=8000

Then visit http://my-app.local:8000/

• with Rome:

pnpm check

• with Pint:

composer check

• Using PHPStan:

composer analyse

• using Vitest:

pnpm test

• using PEST:

composer test

🚀 Execute end-to-end testing with Playwright:

pnpm e2e

• Frontend:

pnpm debug

- Backend:

```shell
composer debug

• Requires PHP 8.1+ (at least 8.1.21 recommended to avoid potential bugs).
• Requires Node JS 18.16+ (at least 18.16.1 recommended to avoid potential bugs).
• Requires Composer >=2.5.8 to manage PHP dependencies.
• Requires pnpm@^8.0.0 to manage JS and TS dependencies.
• Requires Git ~2.40.0 to manage source code versions.

The full documentation for the Sikessem Starter can be found on this address.

The main purpose of this repository is to continue evolving Sikessem. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Sikessem.

Sikessem has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Read our Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Sikessem.

We have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

Larger discussions and proposals are discussed in Sikessem's GitHub discussions.

If you discover a security vulnerability within Sikessem, please email SIGUI Kessé Emmanuel at [email protected]. All security vulnerabilities will be promptly addressed.

The Sikessem Starter is open-sourced software licensed under the MIT License - see the LICENSE file for details.