EOS

Installation

How to set up your project.

Quick Start

The fastest way to get started is to use the CLI.

bash 
# Create a new project from the Adonis EOS Starter
npx adonis-eos@beta init my-project
cd my-project

# Install dependencies
npm install

# Run the setup wizard (Configures .env, DB, keys, and migrations)
npm run setup

# 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.

Next Steps

Refer to the following guides to learn more: