Skip to content

Initial Setup

This guide walks you through the first steps before you start coding.

macOS Setup

  1. Install Xcode Command Line Tools: 
    sudo xcode-select --install
  2. Install MySQL.
  3. Continue to Next Steps.

Apple Silicon (All M-Series Processors)

Note: Installing the Trilogy gem on Apple Silicon Macs requires additional steps:

  1. Install dependencies via Homebrew: 
    brew install mysql openssl zstd
  2. Install the trilogy gem with the following command: 
    gem install trilogy -v '2.10' \
  -- --with-mysql-config=$(brew --prefix mysql)/bin/mysql_config \
  --with-ldflags="-L$(brew --prefix zstd)/lib -L$(brew --prefix openssl)/lib" \
  --with-cppflags="-I$(brew --prefix openssl)/include"

Linux (Ubuntu) Setup

These steps work for most Debian-based distributions (Ubuntu, Mint, etc.).

  1. Install MySQL. ⚠️ Important: Review the "Step 2 — Configuring MySQL" section in the guide.

  2. Install the MySQL client library: 

    sudo apt-get install libmysqlclient-dev

  3. Continue to Next Steps.

Windows (WSL - Windows Subsystem for Linux)

  1. Use the latest Ubuntu LTS version in WSL and open its terminal.

  2. Install MySQL.

  3. Install the MySQL client library: 

    sudo apt-get install libmysqlclient-dev

  4. Continue to Next Steps.
  5. (Optional) Configure Ruby interpreter for RubyMine: Guide.

🐳 Docker

The easiest way to set up your development environment! Avoid dependency issues and manual installations—just run Docker and start coding.

To get started, follow the local Docker guide in docker/README.md.

Next Steps

  1. Install a Ruby version manager: rbenv or RVM.
  2. Install Ruby 4.0.5. The current Ruby version is defined in .ruby-version; the Gemfile allows Ruby ~> 4.0.1.
  3. Install Node.js via nvm and enable Corepack: 
    nvm use
corepack enable
    The current frontend runtime is Node 24.15 with Yarn 4.14.1.
  4. Generate an SSH key: 
    ssh-keygen -t ed25519
  5. Add your SSH key to Easy GitLab: Profile > Preferences > SSH Keys.
  6. Clone the platform repository: 
    git clone [email protected]:devel/devel.git
  7. Navigate to the cloned directory: 
    cd devel
  8. Install Bundler: 
    gem install bundler
  9. Install platform dependencies: 
    bundle install
  10. Set up the database:
    • Copy config/database.yml.example and rename it to config/database.yml.
    • Update database credentials in config/database.yml (Configuration Guide).
    • Prepare your development database:
      • Using an SQL dump: 
        gunzip -c PATH_TO_DUMP | mysql MY_DB_NAME
        (Download a sample dump: demo_database_dump.)
      • OR create a clean database: 
        bundle exec rake db:create RAILS_ENV=development

        WSL Users: Use bundle exec rake db:create RAILS_ENV=development NAME='' instead.

  11. Run database migrations: Easy8 runs database and plugin migrations through the install task: 

    RAILS_ENV=development bundle exec rails easy8:install
    > WSL Users: Use RAILS_ENV=development NAME='' bundle exec rails easy8:install instead.

  12. Start the Rails server (available at http://localhost:3000): 

    bundle exec rails server

  13. (Bonus) Install EasyCLI (highly recommended). > It automates tasks like creating merge requests and simplifying SSH access.

🚂 Choo-Choo! Your Rails Server is Leaving the Station!

Your development environment is now ready!