Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/raczkodavid/Zooniverse/llms.txt

Use this file to discover all available pages before exploring further.

Zooniverse ships with an init.bat script that automates the entire local setup process — from installing Composer dependencies to creating the SQLite database and starting the development server. You can go from a fresh clone to a running application in a single command.

​
Prerequisites

Before you begin, make sure you have the following installed:
  • PHP 8.2 or higher — required by Laravel 12.x
  • Composer — the PHP dependency manager
Verify your PHP version by running php --version. You need at least 8.2.x.

​
Installation

1

Clone the repository

Clone the Zooniverse repository and navigate into the project directory.
git clone <repository-url>
cd Zooniverse
2

Run the initialization script

Run the init.bat script from the project root. This single command handles the full setup.
.\init.bat
The script performs the following steps in order:
StepCommandWhat it does
Install dependenciescomposer installDownloads all PHP packages defined in composer.json
Create .env file(inline)Writes a local environment config with DB_CONNECTION=sqlite and APP_URL=http://localhost:8000
Generate app keyphp artisan key:generateSets the APP_KEY used for encryption
Create SQLite databasetype nul > database\database.sqliteCreates an empty SQLite database file
Run migrations and seedphp artisan migrate:fresh --seedCreates all tables and populates demo data
Create storage symlinkphp artisan storage:linkLinks public/storage to storage/app/public
Start dev serverphp artisan serveStarts the application at http://localhost:8000
3

Access the application

Once the dev server is running, open your browser and go to:
http://localhost:8000
You can log in immediately using the default admin account. See Default Users for credentials.
Zooniverse uses SQLite as its database. No additional database server (MySQL, PostgreSQL, etc.) is required. The database file lives at database/database.sqlite inside the project directory.

​
What the .env file contains

The init.bat script writes a minimal .env file with sensible defaults for local development: 
APP_NAME="Laravel beadandó"
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_TIMEZONE=UTC
APP_URL=http://localhost:8000

DB_CONNECTION=sqlite
FILESYSTEM_DISK=local
If you need to change the timezone or filesystem disk, edit the .env file directly after running init.bat. The APP_KEY field is filled in automatically by php artisan key:generate.

​
Manual setup (optional)

If you prefer to run each step individually instead of using init.bat, you can execute the same commands yourself: 
composer install --no-interaction --quiet
php artisan key:generate
type nul > database\database.sqlite
php artisan migrate:fresh --seed
php artisan storage:link
php artisan serve
The init.bat script is designed for Windows. On macOS or Linux, run the equivalent shell commands above directly in your terminal. The type nul > command should be replaced with touch database/database.sqlite.

Build docs developers (and LLMs) love

Get started for freeTalk to us