Skip to content

Commit

Permalink
feat: add README for project setup
Browse files Browse the repository at this point in the history
  • Loading branch information
ErwannRousseau committed Nov 24, 2024
1 parent 37eb8fb commit f892bdb
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 20 deletions.
19 changes: 0 additions & 19 deletions LICENSE

This file was deleted.

2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f892bdb

Please sign in to comment.