Skip to content

development

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

development

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
certs
certs
 
 
nginx
nginx
 
 
.env
.env
 
 
README.md
README.md
 
 
docker-compose.dev.yml
docker-compose.dev.yml
 
 
package-lock.json
package-lock.json
 
 
start-dev.sh
start-dev.sh
 
 

README.md

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.

Requirements

  1. Docker – Required for containerized development. Install Docker
  2. Git – Needed to clone the repository. Install Git

Note: This guide assumes a macOS or Linux environment by default. See the Windows setup instructions below if you're on Windows.

Setup instructions (macOS / Linux)

1. Clone the repository

git clone git@github.com:HiEventsDev/Hi.Events.git

2. Start the development environment

Navigate to the Docker development directory and run the startup script:

cd Hi.Events/docker/development
./start-dev.sh

Once running, access the app at:

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:

git clone git@github.com:HiEventsDev/Hi.Events.git
cd Hi.Events/docker/development

2. Generate SSL certificates

You can use openssl to generate self-signed certificates:

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:

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

docker-compose -f docker-compose.dev.yml up -d

4. Install backend dependencies

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":

docker-compose -f docker-compose.dev.yml logs pgsql

6. Create environment files (if missing)

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

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

start https://localhost:8443/auth/register

Additional configuration

Hi.Events uses environment variables for configuration. You’ll find .env files in:

  • frontend/.env
  • backend/.env

You can modify these to customize your setup.

For a full list of environment variables, see the Environment Variables Documentation.