Repository navigation
Installation
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-versionsor.mise.tomlfile in the project root pins the correct versions.
Clone the repository to your local machine:
git clone https://github.com/your-org/laravex.git my-app
cd my-appCopy the example environment file:
cp .env.example .envThe .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.
Fetch and compile Elixir dependencies:
mix deps.get
mix compileLaravex uses an application key for encryption and cookie signing. Generate one with Artisan:
./artisan key:generateThis command writes a new APP_KEY value directly into your .env file. The application will warn you on startup if the key is missing.
Create the database schema:
./artisan migrateBy 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:freshPopulate the database with initial data:
./artisan db:seedThe default seeder lives in database/seeders/database_seeder.ex.
./artisan serveYour application is now available at http://localhost:8000. The server watches for code changes and recompiles automatically in dev mode.
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- Configuration — environment variables, config files, and the config repository
- Directory-Structure — understand the project layout
-
Routing — register your first routes in
routes/web.ex - Artisan-Console — explore all available Artisan commands
Laravex — Laravel-faithful application skeleton & runtime for Elixir.
GitHub
·
Docs
·
Limitations
·
Laravel Docs
Not affiliated with Laravel LLC or the Elixir core team. Built to feel like Laravel on the BEAM.
- Home
- Installation
- Configuration
- Directory-Structure
- Request-Lifecycle
- Service-Container
- Service-Providers
- Deployment
- Routing
- Middleware
- CSRF-Protection
- Controllers
- Requests
- Responses
- Views
- Blade-Templates
- Asset-Bundling
- Session
- Validation
- Error-Handling
- Logging
- Artisan-Console
- Broadcasting
- Cache
- Collections
- Events
- File-Storage
- Helpers
- HTTP-Client
- Localization
- Notifications
- Pipeline
- Queues
- Rate-Limiting
- Strings
- Task-Scheduling