diff --git a/LICENSE b/LICENSE deleted file mode 100644 index bc6b2a1..0000000 --- a/LICENSE +++ /dev/null @@ -1,19 +0,0 @@ -Copyright (c) Fabien Potencier - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is furnished -to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/Makefile b/Makefile index 30b59a1..a8f72cf 100644 --- a/Makefile +++ b/Makefile @@ -24,7 +24,7 @@ build: ## Builds the Docker images up: ## Start the docker hub in detached mode (no logs) @$(DOCKER_COMP) up --detach -start: build up ## Build and start the containers +start: build up tailwind ## Build, start the containers and run the tailwind watch command dev: up tailwind ## Start the docker hub in detached mode and run the tailwind watch command diff --git a/README.md b/README.md new file mode 100644 index 0000000..1908804 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Symfony with Tailwind and Twig Components + +This project is a demonstration of using Tailwind CSS with Twig Components in a Symfony monolith project. +![alt text](screenshot.png) + +## Prerequisites + +- Docker +- Make + +## Starting the project + +1. Clone the repository: + + ```bash + git clone https://github.com/ErwannRousseau/symfony-tailwind-twig-components + cd symfony-tailwind-twig-components + ``` + +2. Build and start the Docker container: + + ```bash + make start + ``` + +3. Access the application in your browser at [https://app.localhost](https://app.localhost). + +### Docker + +This project is based on Docker with frankenphp. +You can find more information on the repo I based myself on, just here: [dunglas/symfony-docker: A Docker-based installer and runtime for Symfony. Install: download and `docker compose up`.](https://github.com/dunglas/symfony-docker) diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..6fa59ad Binary files /dev/null and b/screenshot.png differ