search

FOSS-Community / fosscu.org

The FOSSCU HomePage
https://fosscu.org/
MIT License
40 stars 104 forks source link

[Feature] Enabling DevContainers for Development #199

Closed Mr-Sunglasses closed 1 month ago

Mr-Sunglasses commented 1 year ago

Describe the feature you'd like to request

Developing inside a Container

The Visual Studio Code Dev Containers extension lets you use a container as a full-featured development environment. It allows you to open any folder inside (or mounted into) a container and take advantage of Visual Studio Code's full feature set. A devcontainer.json file in your project tells VS Code how to access (or create) a development container with a well-defined tool and runtime stack. This container can be used to run an application or to separate tools, libraries, or runtimes needed for working with a codebase.

Workspace files are mounted from the local file system or copied or cloned into the container. Extensions are installed and run inside the container, where they have full access to the tools, platform, and file system. This means that you can seamlessly switch your entire development environment just by connecting to a different container.

Describe the solution you'd like

Proposed Steps

  1. Docker Setup: Ensure Docker is installed on the developers' machines. If not, provide instructions for Docker installation.
  2. Container Configuration: Create a devcontainer.json file in the repository root. This file will define the development environment, including the base image, extensions, and settings.
  3. Extensions and Tools: Identify the necessary VS Code extensions, tools, and configurations required for website development. These can include code formatters, linters, debugging tools, and more.
  4. Documentation: Update the repository's README to include instructions on setting up and using DevContainers. This should cover installation, basic usage, and troubleshooting tips.
  5. Testing: Have a few team members test the DevContainer setup on different platforms to ensure it works smoothly across various environments.
  6. Feedback and Iteration: Encourage developers to provide feedback on the DevContainer setup. Iterate on the configuration based on their input.
  7. Integration: Consider integrating the DevContainer setup into the continuous integration (CI) process to catch environment-related issues early in the development pipeline.

Describe alternatives you've considered

No response

Additional context

image

Doc for DevContainers

Saurav-Pant commented 1 year ago

Hi @Mr-Sunglasses ,

I'm interested in working on this GitHub issue. I believe I can contribute effectively, but please be aware that it may take some time to complete.

Could you please assign this issue to me?

Thank you!

Mr-Sunglasses commented 1 year ago

@Saurav-Pant To avoid ambiguity, this issue is not assigned to anyone currently so is available to anyone. Submit a draft PR getting started on the work and we can assign it.

Saurav-Pant commented 1 year ago

ok @Mr-Sunglasses, I will try and raise a PR