Quickstart

This guide covers setting up the development environment for all three applications: backend, frontend, and iOS.

Prerequisites

Before you begin, you must have:

Ruby 3.4+ (via mise or rbenv)
Node.js 20+ (via mise or nvm)
MySQL 8.0+ (local or Docker)
Redis 7+ (local or Docker)
Xcode 15+ (for iOS development)

Backend setup

The Rails API powers all platform functionality.

Clone and install

git clone https://github.com/Evo-Marketing-LLC/evo-dialed-backend.git
cd evo-dialed-backend
bundle install

Configure database

Copy the example database config and update credentials:

cp config/database.yml.example config/database.yml
# Edit config/database.yml with your MySQL credentials

Setup database

bin/rails db:create db:migrate db:seed

Start the server

bin/rails server

The API is now running at http://localhost:3000

Backend environment variables

Key environment variables needed:

Variable	Description
`DATABASE_URL`	MySQL connection string
`REDIS_URL`	Redis connection string
`BETTER_AUTH_SECRET`	Auth signing secret
`SCRAPE_CREATORS_API_KEY`	ScrapeCreators API key

Frontend setup

The Next.js admin dashboard for the EVO team.

Clone and install

git clone https://github.com/Evo-Marketing-LLC/evo-dialed-frontend.git
cd evo-dialed-frontend
npm install

Configure environment

cp .env.example .env.local
# Edit .env.local with your settings

Set NEXT_PUBLIC_API_URL=http://localhost:3000 to point to local backend.

Start development server

npm run dev

The admin dashboard is now running at http://localhost:3001

iOS setup

The creator-facing iOS application.

Clone the repo

git clone https://github.com/Evo-Marketing-LLC/evo-dialed-creator-ios.git
cd evo-dialed-creator-ios

Generate Xcode project

The project uses XcodeGen for project file generation:

xcodegen generate

Open in Xcode

open dialed.xcodeproj

Configure signing

In Xcode, select your development team under Signing & Capabilities.

Run on simulator

Select a simulator and press Cmd+R to build and run.

iOS environment

For local development, update the API base URL in the app configuration to point to your local backend (you may need ngrok or similar for device testing).

Running tests

Backend tests

cd evo-dialed-backend
RAILS_ENV=test bin/rails db:test:prepare test

Frontend type checking

cd evo-dialed-frontend
npm run typecheck

Pre-push checklist

Before pushing to main, ensure:

# Backend
bin/brakeman --no-pager
bin/bundler-audit
bin/rubocop
RAILS_ENV=test bin/rails test

# Frontend
npm run typecheck
npm run lint

Deployment

Never deploy with railway up or direct uploads. Always push to GitHub and let Railway deploy from the commit.

Backend (Railway)

Push to main branch triggers Railway deployment:

git push origin main

Verify deployment:

curl -sS -o /dev/null -w "%{http_code}\n" https://dialedapi.evomarketing.co/up
# Should return 200

Frontend (Vercel)

Push to main branch triggers Vercel deployment automatically.

Getting help

Check the architecture overview for system design
See backend documentation for API details
Review admin console guides for feature usage

Getting Started

Platform Guide

Admin Console

Notifications

Backend

Frontend

iOS App

Integrations

Prerequisites

Backend setup

Backend environment variables

Frontend setup

iOS setup

iOS environment

Running tests

Backend tests

Frontend type checking

Pre-push checklist

Deployment

Backend (Railway)

Frontend (Vercel)

Getting help

​Prerequisites

​Backend setup

​Backend environment variables

​Frontend setup

​iOS setup

​iOS environment

​Running tests

​Backend tests

​Frontend type checking

​Pre-push checklist

​Deployment

​Backend (Railway)

​Frontend (Vercel)

​Getting help

Prerequisites

Backend setup

Backend environment variables

Frontend setup

iOS setup

iOS environment

Running tests

Backend tests

Frontend type checking

Pre-push checklist

Deployment

Backend (Railway)

Frontend (Vercel)

Getting help