Local Setup

This project was setup using laravel, Inertia, and Vue.js. Herd is reccomended for the local laravel setup

Mac Setup:

Instructions to install herd are here: Herd

The best way to handle this setup is once herd is up and running, navigate to the project directory locally and run herd link to link herd to that directory.

Node Version >= 20.0 PHP Version >= 8.0

1. Clone repository to local device
2. Composer install as well as node install composer install npm install
3. Run php artisan key:generate to generate local app key
4. Setup local env file to match local setup, should only need your own db credentials
5. If herd is successfully installed, you will need to add '.test' to the local APP_URL APP_URL=http://localhost.test
6. Run php artisan migrate:fresh --seed (may need to be re-run if duplicates are randomly created)
7. Run npm run dev to show project in web browser
8. Run php artisan serve to view the project

Windows

Herd is only available to Mac users, otherwise you can use a Docker environment. To do so id reccomend laravel sail.

Node Version >= 20.0 PHP Version >= 8.0

1. Clone repository to local device
2. Follow sail local setup: Sail Navigate to the 'Installing sail to existing applications'
3. Composer install as well as node install ./vendor/bin/sail composer install ./vendor/bin/sail npm install
4. Setup local env file to match local setup, should only need your own db credentials
5. Run ./vendor/bin/sail artisan migrate:fresh --seed (may need to be re-run if duplicates are randomly created)
6. Run ./vendor/bin/sail npm run dev to show project in web browser

If the migrations ran and your projet built, you should be set!