Skip to content

Add concise project setup instructions #629

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+47 −0
Open

Add concise project setup instructions #629

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 47 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,50 @@ docker compose up
```

You will need to provide an `auth.json` file that has credentials for downloading Laravel Nova. Ask in Slack and we can provide this file to you.


🚀 Run Project Locally (Laravel + React + Inertia.js)
Copy link
Member

@kberzinch kberzinch Oct 26, 2025

Choose a reason for hiding this comment

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

This project does not use React or Inertia.

✅ Requirements

Make sure the following are installed:

PHP 8.1+
Copy link
Member

@kberzinch kberzinch Oct 26, 2025

Choose a reason for hiding this comment

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

Our project is declared to require PHP 8.3 or higher in composer.json.


Composer

Node.js & NPM

MySQL (or MariaDB)

Git

📌 Installation Steps
# Clone the repository
git clone <repo-url>
cd <project-folder>

# Install Laravel dependencies
composer install

# Install frontend dependencies
npm install
Copy link
Member

@kberzinch kberzinch Oct 26, 2025

Choose a reason for hiding this comment

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

There are no npm manifest files in this repository.


# Setup environment file
cp .env.example .env
php artisan key:generate

# Configure your database in .env file
# Then run migrations + seeders
php artisan migrate --seed

# Start backend server (Laravel)
php artisan serve # => http://127.0.0.1:8000

# Start frontend (React + Vite)
npm run dev # Auto reloads in browser
Copy link
Member

@kberzinch kberzinch Oct 26, 2025

Choose a reason for hiding this comment

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

There are no npm manifest files in this repository.


🧹 Optional Commands (Fix Common Issues)
php artisan config:clear
php artisan cache:clear
npm run build