Skip to content

test_run.md

Latest commit

 

History

History
112 lines (75 loc) · 2.79 KB

test_run.md

File metadata and controls

112 lines (75 loc) · 2.79 KB

Local Development Environment

Overview

This guide explains how to quickly set up a local development environment for Marble. This setup is optimized for fast testing and development, not for production use.

Quick Start

  1. Clone the Repository

    git clone [email protected]:checkmarble/marble.git
cd marble

  2. Start the Environment

    docker compose -f docker-compose-dev.yaml  --env-file .env.dev.example up

    💡 Tip: Create your own .env.dev file based on .env.dev.example for custom configuration.

Included Components

The development environment includes everything needed to run Marble locally:

Core Services

  • Marble API (Backend)
  • Marble Worker
  • Marble Frontend

Development Dependencies

  • PostgreSQL database
  • Firebase Auth Emulator
  • Elasticsearch instance
  • Object storage emulation

Configuration

Basic Setup

The .env.dev.example provides a minimal configuration that works out of the box.

If you need to modify this configuration, note that the .env files are not inherited by the containers created by Docker Compose directly. Only select variables from the files are passed to the containers. If you need to add new variables (for example, if you want to configure file storage to point at your own S3 bucket), you will also need to edit the Docker Compose file to pass those variables to the appropriate container.

Optional Features

You can enhance your development environment by configuring:

  1. Webhooks Testing

  2. Sanctions Screening

    • Enable Motiva integration
    • Configure Elasticsearch

  3. Storage Features

    • Set up local storage
    • Or connect to cloud storage

Troubleshooting

Common Issues

  1. Port Conflicts

    # Check for port usage
lsof -i :8080
lsof -i :3000

  2. Database Connection

    • Ensure PostgreSQL is running
    • Check connection settings
    • Verify database exists

  3. Firebase Emulator

    • Wait for complete startup
    • Check emulator logs
    • Verify port accessibility

Logs and Debugging

Access service logs:

# All services
docker compose logs -f

# Specific service
docker compose logs -f api

Environment Variables

See the following files for configuration options:

  • .env.dev.example: Development defaults
  • .env.example: All available options
  • docker-compose.yaml: Service configuration

Next Steps

⚠️ Remember: This setup is for development only. See the Production Deployment Guide for production setup.