Skip to content

Open-source event management and ticket selling platform — perfect for concerts, conferences, and everything in between 🎟️ If you find this project helpful, please consider giving us a star ⭐️

Update development readme

Dave Earley5895edaf579e
diff --git a/docker/development/README.md b/docker/development/README.md
index f76ecdf24..ba575b250 100644
--- a/docker/development/README.md
+++ b/docker/development/README.md
@@ -1,25 +1,20 @@
-Here’s a cleaner and more polished version of your Hi.Events local development guide:
-
----
-
# Hi.Events local development with Docker
-This guide walks you through setting up Hi.Events using Docker, including requirements, setup steps, configuration, and
-environment variables.
+This guide walks you through setting up Hi.Events using Docker, including requirements, setup steps, configuration,
+and environment variables.
## Requirements
1. **Docker** – Required for containerized development. [Install Docker](https://docs.docker.com/get-docker/)
-2. **Git** – Needed to clone the
- repository. [Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+2. **Git** – Needed to clone the repository. [Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
-> **Note:** This guide assumes a macOS or Linux environment. Windows users may need to adjust certain commands.
+> **Note:** This guide assumes a macOS or Linux environment by default. See the **Windows setup instructions** below if you're on Windows.
-## Setup instructions
+---
-### 1. Clone the repository
+## Setup instructions (macOS / Linux)
-Clone the Hi.Events GitHub repository:
+### 1. Clone the repository
```bash
git clone [email protected]:HiEventsDev/Hi.Events.git
@@ -38,6 +33,83 @@ Once running, access the app at:
- **Frontend**: [https://localhost:8443](https://localhost:8443)
+---
+
+## Setup instructions (Windows)
+
+Windows users should follow the steps below to manually run the setup commands instead of using the `start-dev.sh` script.
+
+### 1. Clone the repository
+
+Using Git Bash or Windows Terminal:
+
+```bash
+git clone [email protected]:HiEventsDev/Hi.Events.git
+cd Hi.Events/docker/development
+```
+
+### 2. Generate SSL certificates
+
+You can use `openssl` to generate self-signed certificates:
+
+```bash
+mkdir -p certs
+openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout certs/localhost.pem.key -out certs/localhost.pem -subj "/CN=localhost"
+```
+
+Then, update your `docker/development/nginx/nginx.conf` to use `.pem` files:
+
+```nginx
+ssl_certificate /etc/nginx/certs/localhost.pem;
+ssl_certificate_key /etc/nginx/certs/localhost.pem.key;
+```
+
+> If you're using `.crt`/`.key`, update accordingly.
+
+### 3. Start Docker services
+
+```bash
+docker-compose -f docker-compose.dev.yml up -d
+```
+
+### 4. Install backend dependencies
+
+```bash
+docker-compose -f docker-compose.dev.yml exec -T backend composer install --ignore-platform-reqs --no-interaction --optimize-autoloader --prefer-dist
+```
+
+### 5. Wait for the database
+
+Keep checking logs until you see "ready to accept connections":
+
+```bash
+docker-compose -f docker-compose.dev.yml logs pgsql
+```
+
+### 6. Create environment files (if missing)
+
+```bash
+docker-compose -f docker-compose.dev.yml exec backend cp .env.example .env
+docker-compose -f docker-compose.dev.yml exec frontend cp .env.example .env
+```
+
+### 7. Laravel setup
+
+```bash
+docker-compose -f docker-compose.dev.yml exec backend php artisan key:generate
+docker-compose -f docker-compose.dev.yml exec backend php artisan migrate
+docker-compose -f docker-compose.dev.yml exec backend chmod -R 775 /var/www/html/vendor/ezyang/htmlpurifier/library/HTMLPurifier/DefinitionCache/Serializer
+docker-compose -f docker-compose.dev.yml exec backend php artisan storage:link
+```
+
+### 8. Open the app
+
+```bash
+start https://localhost:8443/auth/register
+```
+
+---
+
## Additional configuration
Hi.Events uses environment variables for configuration. You’ll find `.env` files in:
@@ -47,5 +119,4 @@ Hi.Events uses environment variables for configuration. You’ll find `.env` fil
You can modify these to customize your setup.
-For a full list of environment variables, see
-the [Environment Variables Documentation](https://hi.events/docs/getting-started/deploying#environment-variables).
+For a full list of environment variables, see the [Environment Variables Documentation](https://hi.events/docs/getting-started/deploying#environment-variables).