qsomazzi/particle

Particle is a versatile Symfony Bundle that provides a collection of Twig components based on the free templates from Tabler.

0.0.1 2024-04-29 16:07 UTC

Requires

• php: >=8.2
• symfony/config: ^6.4
• symfony/http-foundation: 6.4
• symfony/http-kernel: 6.4
• symfony/ux-twig-component: ^2.17

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.54
• pestphp/pest: ^2.34
• phpstan/phpstan: ^1.10

MIT

• Quentin SOMAZZI

README

Particle is a versatile Symfony Bundle that provides a collection of Twig components based on the free templates from Tabler. It offers a base layout and a set of components to streamline the development of Symfony applications.

Features

• Easy integration of Tabler template components into Symfony projects.
• Simplified development with pre-designed UI components.
• Customizable and extendable components to fit various project needs.

Installation

You can install Particle using Composer:

composer require qsomazzi/particle

Usage

1. Configuration: Customize Particle's configuration options in your Symfony application's config/packages/particle.yaml file.

2. Twig: Update twig configuration to add Particle's Namespace

twig:
    ...
    paths:
        '%kernel.project_dir%/vendor/qsomazzi/particle/templates': Particle

1. Templates: Use Particle's Twig components in your templates to build sleek and responsive UIs effortlessly.

{% extends '@Particle/base.html.twig' %}

{% block title %}Welcome to My Symfony App{% endblock %}

{% block content %}
    <div class="container">
        <h1>Hello, Particle!</h1>
        <!-- Your content here -->
    </div>
{% endblock %}

1. Extend and Customize: Extend Particle's components or create your own to tailor them to your project's specific requirements.

2. Read the doc: Read the documentation here.

Contributing

Contributions are welcome! Whether you want to report a bug, request a feature, or contribute code, please follow our contribution guidelines.

License

Particle is open-source software licensed under the MIT license.

Support

For questions or support, please open an issue on GitHub.