Resilience Atlas

Architecture

Directory	Description	Documentation	Tech Stack
frontend	Frontend application	frontend/README.md	React 19.2.0, Next.js 16.1.1, Node.js 24.0.0
backend	Ruby on Rails backend (API + backoffice)	backend/README.md	Ruby 3.4.8, Rails 7.2.x
cloud_functions	AWS Lambda functions	cloud_functions/README.md	AWS Lambda
infrastructure	Terraform for TiTiler COG tiler	infrastructure/README.md	Terraform, AWS
data	Data processing scripts	data/README.md	Various tools

Environments

• Production: resilienceatlas.org (deployed from main branch)
• Staging: staging.resilienceatlas.org (deployed from staging branch)

Quick Start

Prerequisites

• Docker and Docker Compose

Development Setup

1. Set up environment variables

   cp .env.example .env
   cp frontend/.env.example frontend/.env
   cp backend/.env.sample backend/.env

2. Start the development environment

   docker compose -f docker-compose.dev.yml up --build

   This starts:

   • PostgreSQL database on port 5432
   • Backend API on http://localhost:3001
   • Frontend application on http://localhost:3000

3. Admin Panel Access

   The admin panel is available at http://localhost:3001/admin with the following default credentials:

   Field	Value
   Email	admin@example.com
   Password	password

Hybrid Development (Database in Docker, Apps Local)

For faster development iteration, you can run only the database in Docker while running the frontend and backend locally:

1. Start only the database

   docker compose -f docker-compose.dev.yml up -d db

2. Start the backend (requires Ruby 3.4.8)

   cd backend
   bundle install
   bin/rails db:setup    # First time only
   bin/rails server -p 3001

3. Start the frontend (requires Node.js 24.0.0)

   cd frontend
   npm install
   npm run dev

The frontend will be available at http://localhost:3000 and the backend at http://localhost:3001.

Note: This approach requires having the correct Ruby and Node.js versions installed locally. Use the full Docker setup if you don't have these versions available.

Running Tests

Backend Tests

# Run all backend tests
docker compose -f docker-compose.test.yml run --rm backend-test ./bin/test

# Individual commands
docker compose -f docker-compose.test.yml run --rm backend-test ./bin/test rspec    # Unit tests
docker compose -f docker-compose.test.yml run --rm backend-test ./bin/test lint     # StandardRB
docker compose -f docker-compose.test.yml run --rm backend-test ./bin/test security # Brakeman
docker compose -f docker-compose.test.yml run --rm backend-test ./bin/test system   # Browser tests

Frontend Tests

# Run all frontend checks
docker compose -f docker-compose.test.yml run --rm --no-deps frontend-test ./bin/test

# Individual commands
docker compose -f docker-compose.test.yml run --rm --no-deps frontend-test ./bin/test lint
docker compose -f docker-compose.test.yml run --rm --no-deps frontend-test ./bin/test type-check
docker compose -f docker-compose.test.yml run --rm --no-deps frontend-test ./bin/test build

Integration Tests

docker compose -f docker-compose.test.yml up --abort-on-container-exit

Documentation

• Testing Documentation
• TiTiler COGs Service
• Scripts Documentation
• Frontend README
• Backend README

License

See LICENSE for details.