Skip to content

Installation

David Ciulla edited this page Nov 7, 2026 · 1 revision

Installation

Prerequisites

Before installing Laravex, make sure the following are available on your machine:

Requirement Version
Elixir ~> 1.17
Erlang/OTP compatible with your Elixir release (OTP 26+ recommended)
SQLite 3.x (default database driver; no external DB server needed)

Tip: Use asdf or mise to manage Elixir and Erlang versions. The .tool-versions or .mise.toml file in the project root pins the correct versions.


Obtaining Laravex

Clone the repository to your local machine:

git clone https://github.com/your-org/laravex.git my-app
cd my-app

Environment Configuration

Copy the example environment file:

cp .env.example .env

The .env file holds your application secrets and environment-specific settings. At minimum, review the following keys:

APP_NAME=Laravex
APP_ENV=local
APP_KEY=                  # generated in the next step
APP_DEBUG=true
APP_URL=http://localhost:8000

DB_CONNECTION=sqlite
SESSION_DRIVER=database
CACHE_STORE=database
QUEUE_CONNECTION=database

See Configuration for a full reference of all available keys.


Installing Dependencies

Fetch and compile Elixir dependencies:

mix deps.get
mix compile

Generating the Application Key

Laravex uses an application key for encryption and cookie signing. Generate one with Artisan:

./artisan key:generate

This command writes a new APP_KEY value directly into your .env file. The application will warn you on startup if the key is missing.


Running Migrations

Create the database schema:

./artisan migrate

By default, Laravex uses SQLite. The database file is created automatically at the path specified by your DB_CONNECTION configuration (storage/database.sqlite by convention).

To start fresh, wipe and re-migrate:

./artisan migrate:fresh

Seeding the Database

Populate the database with initial data:

./artisan db:seed

The default seeder lives in database/seeders/database_seeder.ex.


Starting the Development Server

./artisan serve

Your application is now available at http://localhost:8000. The server watches for code changes and recompiles automatically in dev mode.


Verifying the Installation

Open your browser to http://localhost:8000. You should see the Laravex welcome view. You can also check the health endpoint:

curl http://localhost:8000/up        # plain text "OK"
curl http://localhost:8000/health    # JSON with database status

Next Steps

Clone this wiki locally