Getting Started

Here are some basic steps to get the project up and running on your computer.

The project currently use DDEV for development, so you must download it first: https://ddev.com/

Clone repository

git clone git@github.com:santerref/puzzle.git

cd puzzle

ddev start

ddev composer install

ddev npm i

Copy the .env.sample and set the values to your environment (default to DDEV database):

cp .env.sample .env

Files can be stored in storage/public and storage/private. To see the public files like images, you need to create a symlink.

ddev puzzle storage:link

Run this command in the background in another terminal to run Vite in server mode:

ddev vite

Run this command to build assets in production:

ddev vite build

Once Vite is running, you need to run the installer to create database tables.

Once the installation is done (blank page), you can test the page builder: https://puzzle.ddev.site/login

You can also open Puzzle with this DDEV command:

ddev launch

If you would like to see the database structure and the data, you can run:

ddev phpmyadmin