README.md

Sikessem Starter

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

🔖 Contents

• 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

🎉 Getting Started

⚡️ Installation

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

composer create-project sikessem/starter 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:

bun install

🍱 Build assets

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

bun run build

🗃️ Manage Database

Install migrations:

php artisan migrate:install && php artisan migrate

🌐 Starting server

Run the server in development mode:

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

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

🧪 Testing and debugging

🧹 Keep a modern codebase

• with Biome:

bun check

• with Pint:

composer check

⚗️ Run static analysis

• Using PHPStan:

composer analyse

✅ Run unit tests

• using Bun:

bun run test

• using PEST:

composer test

🚀 Execute end-to-end testing with Playwright:

bun e2e

🐛 Check all code bugs

• Frontend:

bun debug

• Backend:

composer debug

📋 Requirements

• Requires PHP 8.2+ (at least 8.2.14 recommended to avoid potential bugs).
• Requires Bun 1.0+ (at least 1.0.21 recommended to avoid potential bugs).
• Requires Composer >=2.6.6 to manage PHP dependencies.
• Requires Git ~2.42.0 to manage source code.

📖 Documentation

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

👏 Contribution

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.

👷 Code of Conduct

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.

👥 Contributing Guide

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.

🔒️ Good First Issues

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.

💬 Discussions

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

🔐 Security Reports

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

📄 License

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

---

_{Made with ❤︎ by @siguici.}