EOS

Installation

How to set up your Adonis EOS project.

Quick Start

The fastest way to get started with Adonis EOS is to use our starter kit.

bash 
# Create a new project from the Adonis EOS starter kit
npm init adonisjs@latest my-cms-project -- --kit=spaced-man/adonis-eos-starter
cd my-cms-project

# Setup PostgreSQL Database (Skip if already handled)
# sudo -u postgres psql -c "CREATE USER adonis_eos WITH PASSWORD 'password';"
# sudo -u postgres psql -c "CREATE DATABASE adonis_eos_db OWNER adonis_eos;"

# Configure environment
cp .env.example .env
# Update DB_USER, DB_PASSWORD, and DB_DATABASE in .env to match the above

# Generate APP_KEY (required)
node ace generate:key

# Run migrations
node ace migration:run

# Seed initial data
node ace db:seed

# Start development server
npm run dev

System Requirements

  • Node.js: 18.0.0 or higher

  • Database: PostgreSQL (recommended), MySQL, or SQLite

  • Memory: 1GB minimum (2GB+ recommended for production)

Manual Installation

If you prefer to clone the repository directly:

  1. Clone the repository: git clone https://github.com/spaced-man/adonis-eos.git

  2. Install dependencies: npm install

  3. Follow the configuration steps above.

Default Accounts

After seeding the database (node ace db:seed), you can log in with the following default accounts (password for all is supersecret):

⚠️ Security Warning: These default accounts are provided for development and initial setup only. You must change the passwords for all accounts (especially the Admin account) immediately after first login and prior to any production deployment.

Project Structure

Refer to the Project Structure guide for a detailed breakdown of the codebase.