README

?? Palet Application Skeleton

The official, enterprise-ready starter application for the Palet PHP Framework.

?? Introduction

Palet Skeleton is the official starting point for building powerful web applications with the Palet Framework. It provides a meticulously structured, modern MVC architecture right out of the box, featuring Tailwind CSS styling, advanced routing, robust error handling, and a dedicated CLI tool.

Note: This repository contains the application skeleton. The core framework logic lives in the palet-framework repository.

?? Installation

To create a new Palet project, make sure you have PHP 8.3+ and Composer installed, then run the following command in your terminal:

composer create-project omasat/palet-skeleton my-app

The installation wizard will automatically:

Download the latest stable version of the framework.
Generate your .env configuration file.
Automatically run php palet install to guide you through database setup and generate your secure APP_KEY.

??? Getting Started

Once your project is created, simply navigate to the directory and start the built-in development server:

cd my-app
php palet serve

Your application will now be accessible at http://localhost:8000.

?? Directory Structure

Palet embraces a clean and intuitive directory structure:

app/: Your application core logic (Controllers, Models, Middleware, Providers).
bootstrap/: Application bootstrapping and IoC Container initialization.
config/: Centralized configuration files (Database, Mail, Cache, Security, etc.).
database/: Database migrations, seeders, and model factories.
docs/: In-depth documentation regarding deployment and architecture.
public/: The web server document root (contains index.php and static assets like CSS/JS).
resources/: Your view templates (.php files) and raw frontend assets.
routes/: Route definitions for your application (web.php, api.php).
storage/: Application generated files like cache, session data, and compiled views.
tests/: Automated feature and integration tests powered by PHPUnit.

? Key Features

Built-in CLI (palet): Automate tasks like serving, migrating databases, and clearing caches.
Auto-CSRF Protection: Form submissions are automatically protected against CSRF without manual token injection.
Whoops Error Handling: Beautiful, modern error pages for a superior developer experience.
IoC Container: Powerful dependency injection container out of the box.
RESTful Routing: Intuitive and fast routing engine.
Cache-based Rate Limiting: High-performance throttling for your APIs.

?? Documentation

For detailed deployment guides, configuration instructions, and security best practices, please explore the markdown files inside the docs/ directory.

?? License

The Palet Framework and this application skeleton are open-sourced software licensed under the MIT license.

omasat / palet-skeleton

Package info

Security

Statistics