Quick Start Guide

The easiest and recommended way to try Hi.Events is to use Docker. Docker will run the entire application in a series of containers, so you don't have to worry about installing any dependencies (other than Docker).

Deploying to a Cloud Provider

For information on deploying to a Cloud Provider, see here.

Quick Start with Docker

If you want to get Hi.Events up and running quickly without focusing on local development, use the following commands in your terminal:

git clone https://github.com/HiEventsDev/hi.events.git
cd hi.events/docker/all-in-one
# Follow the instructions in the README in ./docker/all-in-one to generate the APP_KEY and JWT_SECRET
docker-compose up -d

This will set up the entire application using Docker Compose.

Local Development Environment

For those interested in local development, follow these steps to quickly get Hi.Events up and running:

Clone the repository:

git clone https://github.com/HiEventsDev/hi.events.git

Change directory to the Docker setup folder for development:

cd hi.events/docker/development

Start the services with Docker Compose:

./start-dev.sh

ℹ️

By default, the local environment uses unsigned keys. This means your browser will show a warning saying the site is unsecure. This can safely be ignored. There are instructions on how to generate signed keys in the local development guide.

For a more detailed setup, including configuration of environment variables and external services, continue with the installation guide.

Getting Started Local Development