chore: Add Docker setup and configuration files

[akashsingh6474]

Summary

Briefly describe the purpose of this PR.

This pull request introduces the setup and configuration files for Docker to streamline the development and deployment process. It includes Docker files for both the frontend and backend, as well as necessary configurations for building and running the application in isolated containers. Additionally, the PR ensures that the application can be easily deployed with consistent environments across different systems.

Description
This pull request introduces a complete Docker setup for the project, aiming to streamline the development, testing, and deployment processes by containerizing both the frontend and backend services. Additionally, it includes configuration for auxiliary services such as MongoDB and Redis to improve the scalability and maintainability of the application.

Problem Being Solved:
Inconsistent development environments across different developers' machines, leading to potential bugs that arise due to differing configurations.
Difficulty in replicating the production environment locally, which affects the testing process.
Managing and coordinating multiple services such as MongoDB and Redis, which can be challenging without proper isolation.
Approach Taken:
Docker Setup for Frontend: A Dockerfile has been created for the React-based frontend. It sets up a clean environment with all necessary dependencies, ensuring consistency across systems.
Docker Setup for Backend: The backend, built with Node.js, is containerized using a separate Dockerfile. It installs necessary dependencies and configures the environment for the application to run in isolation.
Multi-Container Docker Setup: Using Docker Compose, we have defined a multi-container environment for the backend, frontend, MongoDB, and Redis. This allows the services to run independently while communicating via Docker networks.
Environment Variables: The .env.docker file ensures that the containerized application can securely use environment variables to store sensitive information like database credentials, API keys, etc.
Automated Docker Engine Installation Script: A script is included that automates the installation of Docker Engine on Linux systems to facilitate easy setup of the development environment.
Technical Details:
New Files:
.dockerignore - Optimizes Docker builds by excluding unnecessary files.
.env.docker - Configures environment variables for the Docker containers.
docker-compose.yml - Defines the services for frontend, backend, MongoDB, and Redis in a multi-container setup.
get-docker.sh - A script to automate the installation of Docker Engine.
Updated Files:
.env.sample - Updated environment variable values to ensure proper connections to MongoDB and Redis.
Frontend Configuration - Modified the API path to point to an external server (backend service inside the Docker network).

Prerequisites
Have you followed all the CONTRIBUTING GUIDELINES?

Summary by CodeRabbit
New Features:

Introduced a new .dockerignore file to optimize Docker builds by excluding unnecessary files.
Added a new environment configuration file for Docker deployment, defining essential variables for application operation.
Implemented a multi-container Docker setup with services for MongoDB, backend, frontend, and Redis.
Updates:

Updated environment variable values in .env.sample for MongoDB and Redis connections.
Modified the API path in the frontend configuration to point to an external server.
Scripts:

Added a script for automated Docker Engine installation on Linux systems

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request introduce several new configuration files and modifications related to Docker and environment settings for a backend application. A new .dockerignore file has been created to optimize Docker builds by excluding unnecessary files. Additionally, a new environment configuration file for Docker deployment has been added, defining essential variables. The .env.sample file has been updated to reflect changes in MongoDB and Redis URLs. A multi-stage Dockerfile for both backend and frontend applications has been introduced, along with a script for installing Docker on Linux systems.

Changes

File	Change Summary
backend/.dockerignore	New file created to specify files to ignore during Docker image builds.
backend/.env.docker	New environment configuration file for Docker with essential variables.
backend/.env.sample	Updated MongoDB URI, Redis URL, and Frontend URL to point to remote servers.
backend/Dockerfile	Introduced a multi-stage Dockerfile for the backend application.
frontend/.env.sample	Updated VITE_API_PATH to point to a remote server.
frontend/Dockerfile	Introduced a multi-stage Dockerfile for the frontend application.
frontend/get-docker.sh	New script added for installing Docker on Linux systems.
docker-compose.yml	Configuration for multi-container Docker application with services for MongoDB, backend, frontend, and Redis.

Assessment against linked issues

Objective	Addressed	Explanation
Introduce Docker configurations	✅
Update environment variables	✅
Optimize Docker build process	✅

🐰 In the land of code, where changes bloom,
A new .dockerignore clears up the room.
With variables set for the backend's delight,
Docker and scripts make everything right.
From local to remote, the paths now align,
Hopping along, our app's ready to shine! 🌟

---

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 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.

[github-actions]

Hey @akashsingh6474! Thanks for sticking to the guidelines! High five! 🙌🏻

[github-actions]

Hey @akashsingh6474! Thanks for sticking to the guidelines! High five! 🙌🏻

[akashsingh6474]

Looks great overall! Here are a few suggestions for improvement:

Docker Setup: The Docker configuration is well-structured. Ensure that the .env.docker file is correctly configured with all necessary environment variables for deployment.
Prettier Formatting: It seems like there are some Prettier formatting issues in the code. Please run Prettier on the staged files to ensure consistent code style.
Documentation: Consider adding a brief README section explaining how to set up and run the Docker containers, as well as any dependencies needed.

[github-actions]

Hey @coderabbitai[bot]! Thanks for sticking to the guidelines! High five! 🙌🏻

[coderabbitai]

Skipped: Cannot respond to another bot.

[github-actions]

Hey @akashsingh6474! Thanks for sticking to the guidelines! High five! 🙌🏻

[akashsingh6474]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request introduce several new configuration files and modifications related to Docker and environment settings for a backend application. A new .dockerignore file has been created to optimize Docker builds by excluding unnecessary files. Additionally, a new environment configuration file for Docker deployment has been added, defining essential variables. The .env.sample file has been updated to reflect changes in MongoDB and Redis URLs. A multi-stage Dockerfile for both backend and frontend applications has been introduced, along with a script for installing Docker on Linux systems.

Changes

File Change Summary
backend/.dockerignore New file created to specify files to ignore during Docker image builds.
backend/.env.docker New environment configuration file for Docker with essential variables.
backend/.env.sample Updated MongoDB URI, Redis URL, and Frontend URL to point to remote servers.
backend/Dockerfile Introduced a multi-stage Dockerfile for the backend application.
frontend/.env.sample Updated VITE_API_PATH to point to a remote server.
frontend/Dockerfile Introduced a multi-stage Dockerfile for the frontend application.
frontend/get-docker.sh New script added for installing Docker on Linux systems.
docker-compose.yml Configuration for multi-container Docker application with services for MongoDB, backend, frontend, and Redis.

Assessment against linked issues

Objective Addressed Explanation
Introduce Docker configurations ✅
Update environment variables ✅
Optimize Docker build process ✅

🐰 In the land of code, where changes bloom,
A new .dockerignore clears up the room.
With variables set for the backend's delight,
Docker and scripts make everything right.
From local to remote, the paths now align,
Hopping along, our app's ready to shine! 🌟

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
🪧 Tips