Skip to content

🧑‍💻 Local Development Setup

Instructions for getting RawDigs running locally.

RawDigs ships with Laravel Sail, so Docker is the only hard dependency on your workstation. PHP and Node run inside the containers.

Prerequisites

  • Docker Desktop or Docker Engine 20+
  • Docker Compose v2 (bundled with recent Docker Desktop releases)
  • Git
  • Composer (host-side) to download Sail

1. Clone & bootstrap

git clone https://github.com/your-org/rawdigs-core-app.git rawdigs
cd rawdigs
cp .env.example .env
composer install
php artisan key:generate   # or ./vendor/bin/sail artisan key:generate

Update .env with any overrides (database engine, mail credentials, queue, etc.). The default Sail stack uses MySQL, Redis, and Meilisearch.

2. Start Sail

./vendor/bin/sail up -d

The first run builds the application container; later starts finish in seconds. Use ./vendor/bin/sail down when you’re done.

3. Install dependencies inside the container

./vendor/bin/sail composer install
./vendor/bin/sail npm install

4. Run migrations and seed data

./vendor/bin/sail artisan migrate --seed

5. Launch the frontend build

./vendor/bin/sail npm run dev    # hot reloading
# or ./vendor/bin/sail npm run build for a production bundle

The application is available at http://localhost. PHP logs, queues, and scheduler output stream to the Sail containers; tail them with ./vendor/bin/sail logs -f.

Common Sail commands

./vendor/bin/sail artisan test
./vendor/bin/sail artisan tinker
./vendor/bin/sail npm run lint
./vendor/bin/sail stop           # pause containers without removing volumes

MkDocs documentation

The docs live in docs/. To preview them locally:

docker compose build docs   # run only when requirements.txt changes
docker compose up docs

Browse to http://localhost:8000 after the container starts.

Need scaffolding help? Check docs/cli/index.md plus the composer run context:* shortcuts for generating and deleting context assets.