luberius/php-tw

A PHP project template with Tailwind CSS integration

v1.0.5 2024-09-22 08:33 UTC

Requires

• php: ^8.0
• luberius/tailwindcss: ^1.0
• symfony/console: ^5.4
• symfony/process: ^5.4

MIT

• Syaril A P

README

PHP-TW is a project template that integrates PHP with Tailwind CSS, providing a streamlined setup for web development projects. It offers a pre-configured environment that you can quickly set up using Composer.

Features

• Quick project setup with a single Composer command
• Integrated Tailwind CSS for efficient styling
• Built-in development server with live CSS updates
• Pre-configured project structure for immediate development

Requirements

• PHP 8.0 or higher
• Composer

Installation

You can create a new PHP-TW project using Composer's create-project command:

composer create-project luberius/php-tw my-new-project

This will create a new directory my-new-project with all the necessary files and dependencies installed.

Usage

Starting the Development Server

After creating your project, navigate to the project directory and start the development server:

cd my-new-project
php wand serve

This will start a PHP development server and Tailwind CSS watcher. Your project will be accessible at http://localhost:6969.

Project Structure

my-new-project/
├── app/
│   ├── css/
│   │   └── app.css
│   └── index.php
├── bootstrap/
│   ├── app.php
│   └── commands/
│       └── ServeCommand.php
├── vendor/
├── .gitignore
├── composer.json
├── tailwind.config.js
└── wand

• app/: Contains your application code
• app/css/app.css: Main CSS file (with Tailwind directives)
• app/index.php: Entry point of your application
• bootstrap/: Contains files for bootstrapping your application
• vendor/: Composer dependencies
• tailwind.config.js: Tailwind CSS configuration file
• wand: Command-line script for various project tasks

Customization

Tailwind CSS

You can customize Tailwind CSS by editing the tailwind.config.js file in your project root. Refer to the Tailwind CSS documentation for more information.

Adding New Commands

To add new commands to your project, create a new PHP file in the bootstrap/commands/ directory. The command will be automatically registered and available through the wand script.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is open-sourced software licensed under the MIT license.

Support

If you encounter any problems or have any questions, please open an issue on the GitHub repository.

Acknowledgements

• Tailwind CSS
• Symfony Console Component

Happy coding with PHP-TW!