/adversial-plant-modelling

Primary LanguageShell

šŸ§  No-frills big brain devcontainer template

What is this?

This is a barebones template that emulates the regular Docker experience as much as possible, and uses a docker-compose.yml to configure the container instead of learning how to use the devcontainer.json file. Automation scripts and .bashrc files are already created if you need to use it to customize your development experience.

On top of that, it also includes some macros to make it easier to write Dockerfiles. It is based on Ubuntu 22.04, but could be easily modified from the Dockerfile.

Pre-requisites

How do I use this?

  1. Clone this repo
  2. Open the folder in VS Code
  3. Click the green button in the bottom left corner of VS Code and select "Reopen in Container"

What's included?

  • Everything you need to configure is in the .devcontainer folder, inside:

    • devcontainer.json - The devcontainer configuration file (see here for more info
    • Dockerfile - The Dockerfile used to build the devcontainer
    • docker-compose.yml - Declaratively configure what you want to expose to the devcontainer
    • post_create.sh - The script that runs after the devcontainer is created
    • post_start.sh - The script that runs after the devcontainer is started
    • .bashrc - The bashrc file that is copied into the devcontainer

  • Also included is some juicy macros:

    • RUN <command> bash function which runs a command like it would in a regular terminal, but also adds to the Dockerfile if it succeeds. E.g.: RUN apt-get install -y curl will install curl and add RUN apt-get install -y curl to the Dockerfile

    • UNRUN undoes any RUN command by removing it from the Dockerfile and attempting to uninstall packages installed (if any) E.g.: UNRUN apt-get install -y curl will remove RUN apt-get install -y curl from the Dockerfile and attempt to uninstall curl.

      Alternatively, running it without a command removes the last Dockerfile line and tries undoing package installations if the line was to install packages.

PR welcome and Enjoy!