docs: adding Docker & Docker Compose

[evereq]

Description

Please include a summary of the changes and the related issue.

Type of Change

• Bug fix
• New feature
• Breaking change
• Documentation update

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings

Previous screenshots

Please add here videos or images of previous status

Current screenshots

Please add here videos or images of previous status

Summary by CodeRabbit

• New Features

  • Added comprehensive Docker Compose configurations for deploying the application
  • Introduced multiple environment files for different deployment scenarios
  • Enhanced README with detailed Docker and Docker Compose deployment instructions

• Infrastructure

  • Added services for PostgreSQL, Zipkin, Cube.js, Elasticsearch, Redis, MinIO, and more
  • Configured networking and environment variables for containerized deployment

• Documentation

  • Updated README with step-by-step Docker and Docker Compose setup guides
  • Provided clear instructions for running the application in different environments

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces comprehensive Docker Compose configurations and environment files for deploying an application in different environments. The changes include new .env files for various deployment scenarios, updated Docker Compose configuration files for infrastructure, API, and web application services, and an enhanced README with detailed Docker deployment instructions. The configurations support production, demo, and build-specific deployments with flexible environment variable management and service dependencies.

Changes

File	Change Summary
.env.* files	Added new environment variables: NODE_ENV=production and IS_DOCKER=true
README.md	Replaced "Quick Start" section with detailed Docker Compose and Docker deployment instructions
docker-compose.*.yml	Added multiple configuration files for different deployment scenarios, including services for API, webapp, database, tracing, analytics, and infrastructure components

Sequence Diagram

sequenceDiagram
    participant User
    participant DockerCompose
    participant WebApp
    participant API
    participant Infrastructure

    User->>DockerCompose: Run docker-compose
    DockerCompose->>Infrastructure: Start supporting services
    Infrastructure-->>DockerCompose: Services ready
    DockerCompose->>API: Start API service
    API-->>DockerCompose: API initialized
    DockerCompose->>WebApp: Start webapp
    WebApp-->>DockerCompose: Webapp running
    User->>WebApp: Access application

Loading

Poem

🐰 Docker's dance, a rabbit's delight,
Containers spinning, configs so bright
Compose and build, services align
Production, demo - everything's fine!
Deployment magic, with just one command 🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4e42b60 and 221d1ab.

📒 Files selected for processing (8)

• .env.compose (1 hunks)
• .env.demo.compose (1 hunks)
• .env.docker (1 hunks)
• README.md (1 hunks)
• docker-compose.build.yml (1 hunks)
• docker-compose.demo.yml (1 hunks)
• docker-compose.infra.yml (1 hunks)
• docker-compose.yml (1 hunks)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.