Skip to main content

Containers

We offer two options for container-based development.

  1. VS Code with Devcontainer
  2. Containerized setup with dip gem

Due to the way our we setup our docker-compose.yml, standard docker-compose up command is not support. Please checkout the "Containerized setup with dip gem option"

If you encounter any errors with our Container setup, please kindly report any issues!

VS Code with Devcontainer​

Forem support VS Code's Devcontainer. Devcontainer is a flexible containized development environment with all the required dependencies set up in under 15 minutes on most modern machine.

Installation​

  1. Download and install Docker Desktop from the Docker's official site
  2. Download and install VS Code with the dev container extension
  3. Fork and clone our Forem repository into your preferred directory. For Window's WSL users, please make sure you place the Forem repository within the linux layer for optimal file loading speed.
  4. Open up the repository with VS Code and you should be prompted with Rebuild and reopen in container. If you don't see it, you can find it in the command line palette , Dev Containers: Rebuild and Reopen in Container, and you're ready to go!

For additional information on Devcontainer, please checkout the offical documentation

image

Containerized setup with dip gem​

dip gem makes it simple to run docker commands and is the main way we use to interact with docker-compose.yml

Installation​

  1. Fork and clone our Forem repository into your preferred directory.
  2. Make sure you have Ruby installed and avaliable. You may use the system provided Ruby or you can install it with a version manager such as Rbenv or rtx.
  3. gem install dip
  4. dip provision to build images and download dependencies.
  5. dip rails s to start the server.

For more commands, run dip ls.