Skip to content

Follow fix to PR #130 for the remaining setup/runtime issues I hit while testing this branch. #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ThingEngineer wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Follow fix to PR #130 for the remaining setup/runtime issues I hit while testing this branch. #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2177033
fix: clarify onboarding setup flow and order of operations
ThingEngineer Mar 11, 2026
b02b8d6
fix: align Sail and Composer with PHP 8.4
ThingEngineer Mar 11, 2026
e2761f8
chore: remove tracked bootstrap cache artifacts
ThingEngineer Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,43 @@

## Project Setup

- [Install PHP](https://www.php.net/manual/en/install.php)
- [Install PHP 8.4](https://www.php.net/manual/en/install.php)
- [Install Composer](https://getcomposer.org/doc/00-intro.md)
- Install Docker
- For Mac: [Docker Desktop](https://docs.docker.com/desktop/install/mac-install/) | [Orbstack](https://docs.orbstack.dev/quick-start#installation)
- For Windows: [Docker Desktop](https://docs.docker.com/desktop/install/windows-install/)
- For Linux: [Docker Desktop](https://docs.docker.com/desktop/install/linux-install/)
- PHP 8.4 is required for the current Composer dependency set.
- Navigate to the project directory and run `composer install`
- Duplicate the .env.example: `cp .env.example .env`
- Start the project containers: `sail up -d`
- Generate a new APP_KEY: `sail artisan key:generate`. This will automatically update the .env file for the APP_KEY value.
- Run initial DB migration scripts: `sail artisan migrate --seed`
Copy link
Copy Markdown
Contributor

@jugglingdev jugglingdev Mar 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have anything to seed for the enrollment bot?

- Run setup scripts: `composer setup`
- For running sail commands, by default, you are required to enter the full path to the executable in `vendor/bin/sail`. Most devs prefer to create an alias in their shell so they only have to type `sail`. Read the sail docs about [configuring a sail alias](https://laravel.com/docs/11.x/sail#configuring-a-shell-alias). Further documentation will assume an alias exists in your shell.
- Note: `composer setup` is host-safe and idempotent for onboarding cache/config clearing, but DB migrations still require Sail to be running.

## Installing Current Project Dependencies

- All project contributors should run these commands every week to ensure your local project is using the current project dependencies.
- `composer install`
- `npm install`
- `npm run build`

First-time setup order:

- `composer install`
- `cp .env.example .env`
- `sail up -d`
- `sail artisan key:generate`
- `sail artisan migrate --seed`
- `composer setup`
- `npm install`
- `npm run build`

Ongoing weekly dependency update order:

- `composer install`
- `composer setup`
- `npm install`
- `npm run build`

## Updating the Project Dependencies

Expand Down
Loading
Loading