Welcome to SWIRL

The SWIRL stack consists of shadcn/ui, Tailwind, Inertia, React, Laravel & and a couple of friends. The purpose of this project is to create an opinionated starter for applications that have robust fundamentals and modern capabilities.

Introduction

Primary Components

• shadcn/ui: A collection of UI components that are designed to be highly customizable and easy to integrate into your projects.
• Tailwind CSS: A utility-first CSS framework that allows you to build custom designs directly in your markup.
• React: A JavaScript library for building user interfaces, particularly single-page applications where you need a fast and interactive user experience.
• Inertia.js: A framework that allows you to create modern single-page applications using classic server-side routing and controllers.
• Laravel: A PHP framework for web artisans, providing an elegant syntax and a robust set of tools for building modern web applications.

Installation

sh -c "$(curl -fsSL https://swirl.mdtrr.com/install)"

Extra

IDE

SWIRL comes with recommendations for Visual Studio Code extensions as well as some useful settings that automate code formatting.

Linting

SWIRL includes a Prettier configuration and multiple Prettier plugins for PHP, the Blade templating engine, JavaScript plugin sorting and even Tailwind CSS.

Changelog

All notable changes to this project will be documented in the CHANGELOG.md file.

Contribution

We welcome contributions from the community! Please read our CONTRIBUTING.md file for guidelines on how to get started.

License

The original code in this repository is licensed under the MIT License © 2024 Modoterra Corporation. See the LICENSE.md file for details.

Third-Party Licenses

This project includes third-party open-source components, such as Laravel, Tailwind CSS, and React, each of which is licensed under its own respective license. For a full list of third-party licenses and attributions, see ATTRIBUTION.md.