intervle - commit a293b65

diff --git a/README.md b/README.md index cd34aa2..41f79d8 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,13 @@ This repository contains the base engine with which the game may be run. Actual ## Setting up the Development Environment -Intervle was developed with Laravel Sail. As such you will require Docker and Docker Compose to use this project. +Intervle was developed with Laravel Sail. As such you will require; + +* Docker +* Docker Compose +* composer + +to use this project. ### 1. Clone the repository @@ -24,7 +30,7 @@ Adjust any settings within this file, such as port numbers or db names. ### 3. Start Sail Environment and generate App key -Start up the sail environment by using; +Run `composer install` in the project root to install project dependencies. You should then be able to start up the sail environment by using; ```shell ./vendor/bin/sail up -d ``` @@ -34,7 +40,7 @@ Then, generate an application key with `./vendor/bin/sail artisan key:generate`. You can now run migrations to intialise the `events` table; ```shell -./vendor/bin/sail artisan migrate +./vendor/bin/sail artisan migrate:fresh ``` The project also includes some extremely basic Event seeders for testing purposes, which you can run by using; ```shell @@ -45,6 +51,12 @@ or ./vendor/bin/sail artisan migrate:fresh --seed ``` +Finally, install node packages and start up the Vite environment for a demo by running +```shell +./vendor/bin/sail npm install +./vendor/bin/sail npm run dev +``` + At this point, you should be able to visit http://localhost/easy/today to demo the game. You may wish to use example data for a slightly more enjoyable demonstration, which can be read about below. ## Event Data Import