Skip to content

[FEATURE] Add Dockerization and set up Live Deployment configuration #281

@khushigoel44-afk

Description

@khushigoel44-afk

Problem Statement

The repository currently lacks a standardized local development environment and does not have a live production deployment:

  1. No Containerization: Contributors must manually manage local Node.js environments and dependencies, leading to potential "it works on my machine" errors during GSSoC.
  2. No Live Preview: There is no live URL or deployment setup for the project, making it difficult for maintainers and contributors to instantly preview UI changes or read the documentation online.

Proposed Solution

Introduce Docker and Docker Compose configurations to provide an isolated, one-command local development setup.
Configure and connect the project for live deployment on Vercel or Render so that a live link can be permanently displayed in the README.md.

Key Deliverables

  1. A root-level Dockerfile optimized for Next.js development.
  2. A docker-compose.yml file mapping port 3000 with local volume mounting for real-time hot-reloading.
  3. A .dockerignore file to exclude node_modules and .next folders from the build context.
  4. A live deployment configuration.
  5. An updated README.md containing the deployment link and clear instructions on how to run the project using Docker.

Benefits

  1. Frictionless Onboarding: New contributors can spin up the project with a single command without worrying about their local Node.js version.
  2. Visibility: Gives the project a public-facing URL where students can actually read the structured CSE notes without needing to clone the code.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions