Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/AlexanderDamont1/Stratus/llms.txt

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

​
Prerequisites

Before you begin, make sure the following are installed on your system:

PHP 8.2+

Required by Laravel 12. Check with php -v.

Composer 2+

PHP dependency manager. Check with composer -V.

Node.js 18+

Required for frontend assets. Check with node -v.

npm

Bundled with Node.js. Check with npm -v.

Git

For cloning the repository. Check with git --version.

Database

SQLite (zero config), MySQL, or PostgreSQL.
SQLite is the easiest option for local development — no separate database server required. Laravel will create the database file automatically.

​
Clone the repository

git clone https://github.com/AlexanderDamont1/Stratus.git
cd Stratus

​
Quick setup

The fastest way to get running is the single setup command: 
composer run setup
This command runs the following steps in sequence:
1

Install PHP dependencies

Runs composer install to download all packages listed in composer.json into vendor/.
2

Create environment file

Copies .env.example to .env if .env does not already exist. This file holds your local configuration — database credentials, app keys, etc.
3

Generate application key

Runs php artisan key:generate to set APP_KEY in your .env. Laravel uses this key for encryption.
4

Run database migrations

Runs php artisan migrate --force to create all tables (users, cache, jobs, sessions, password reset tokens).
5

Install Node dependencies

Runs npm install to download frontend packages into node_modules/.
6

Build frontend assets

Runs npm run build to compile Tailwind CSS and JavaScript with Vite.

​
Manual setup

If you prefer to run each step individually, or need to customise any part of the process:
1

Install PHP dependencies

composer install
2

Create your environment file

cp .env.example .env
Open .env and configure your database connection. For SQLite (recommended for local dev):
.env
DB_CONNECTION=sqlite
# DB_DATABASE is not required — Laravel defaults to database/database.sqlite
For MySQL:
.env
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=stratus
DB_USERNAME=root
DB_PASSWORD=
3

Generate the application key

php artisan key:generate
4

Run migrations

php artisan migrate
5

Install Node dependencies

npm install
6

Build frontend assets

npm run build
For development with hot module replacement, use npm run dev instead. See Local Development for details.

​
Verify the installation

Start the development server: 
php artisan serve
Open http://localhost:8000 in your browser. You should see the Stratus welcome page.
If you set a custom APP_URL in your .env, use that URL instead.

​
Troubleshooting

Laravel needs write access to storage/ and bootstrap/cache/. Run:
chmod -R 775 storage bootstrap/cache
For SQLite, make sure the database file exists:
touch database/database.sqlite
php artisan migrate
For MySQL/PostgreSQL, verify the database exists and your credentials in .env are correct.
If you see an “No application encryption key has been specified” error, run:
php artisan key:generate
Stratus requires Node.js 18 or higher. Check your version with node -v and upgrade if needed. Using nvm is recommended for managing Node versions.

Build docs developers (and LLMs) love

Get started for freeTalk to us