Reisetagebuch

Appearance

Local Development Setup for Reisetagebuch ​

This guide will help you set up your own instance of Reisetagebuch.

Prerequisites ​

The dev-setup of Reisetagebuch uses Laravel Sail for local development. Ensure you have the following installed:

  • PHP >= 8.1
  • Composer
  • Node.js and npm
  • Docker

1. Clone the Repository ​

bash
git clone https://github.com/herrlevin/reisetagebuch.git
cd reisetagebuch

2. Install PHP Dependencies ​

bash
composer install

3. Install Node Dependencies ​

bash
npm install

4. Environment Configuration ​

Copy the environment file and configure it:

bash
cp .env.example .env

Edit .env with your database and other settings:

env
APP_NAME=Reisetagebuch
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost

5. Generate Application Key ​

bash
php artisan key:generate

6. Start the Sail Environment ​

bash
./vendor/bin/sail up -d

7. Migrate and Seed the Database (Optional) ​

For development, you can seed with sample data:

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

8. Create Passport Keys ​

bash
./vendor/bin/sail artisan passport:keys

9. Build Assets ​

bash
npm run build

You can also run the following for continuous development:

bash
npm run dev

Visit http://localhost to see the application.

INFO

Laravel Telescope is enabled in local environment for debugging. Configure in config/telescope.php. You can access it at http://localhost/telescope.

Testing ​

Run the test suite:

bash
./vendor/bin/sail artisan test

Queue Workers ​

Queue jobs are processed by Laravel Horizon, which runs automatically as its own Sail service (horizon) whenever you run sail up -d. The scheduler (schedule:work) also runs as its own Sail service (scheduler), so cron-based jobs run without any extra setup.

You can monitor queues, throughput and failed jobs on the Horizon dashboard at http://localhost/horizon (requires an admin user — there's no CLI command for this yet, so set is_admin to true on your user's row in the users table).

If you need to restart the workers after changing job or queue code, run:

bash
./vendor/bin/sail artisan horizon:terminate

Mobile Apps (Capacitor) ​

The iOS and Android apps are built with Capacitor, wrapping a standalone build of the SPA (separate from the Laravel-served web build, via vite.capacitor.config.mts). To build and sync the native projects:

bash
npm ci
npm run build:capacitor
npx cap sync

npm run build:capacitor builds resources/capacitor into dist-capacitor, which is the webDir the native shells load. npm run cap:sync runs both the build and sync steps together.

After syncing, open the native projects with npm run cap:ios or npm run cap:android.

OSM Import (Geofabrik) ​

If you want to test the Geofabrik import locally, Sail's default PHP image doesn't include the osmium CLI it depends on. Install it once per container via:

bash
docker exec -it reisetagebuch-horizon-1 bash
# inside the container:
apt-get update && apt-get install -y osmium-tool

Next Steps ​