Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Dev Container Configuration for Easy Development Setup in VSCode #695

Open
abdur1547 opened this issue Nov 27, 2024 · 0 comments
Open

Comments

@abdur1547
Copy link

To make it easier for contributors to set up the development environment, I propose adding support for Dev Containers in this repository. This will allow developers using VSCode to start working on the project without manually configuring dependencies or setting up their local environment.

Why This Is Important:

  • Simplifies the onboarding process for new contributors.
  • Ensures a consistent development environment across different machines.
  • Reduces the chances of environment-related issues.

Proposed Implementation:

  • Create a .devcontainer folder in the root directory of the project.
  • Include the following files:
  • devcontainer.json to define the container configuration.
  • A Dockerfile for building the custom environment (if necessary).
  • Optional scripts for initializing the database, installing gems, etc.
  • Configure the development environment with:
  • Ruby (specific version required by the app).
  • PostgreSQL (or the database used by the app).
  • Bundler and other dependencies from the Gemfile.
  • Node.js and Yarn (if the app has frontend assets).
  • Add documentation to the README explaining how to use the dev container setup.

Benefits:

  • One-click setup for developers using VSCode.
  • Easier to reproduce bugs and test contributions in an environment matching the production stack.
  • Lower barrier to entry for new contributors.

I’d be happy to work on this issue if approved. Let me know if there are any additional requirements or constraints!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant