Skip to content
Brian Austin edited this page Sep 16, 2024 · 1 revision

Gitpod is a platform that enables developers to create development environments in the cloud (AKA someone else's computers). The Gitpod configuration in this repository uses Docker under the hood, so that wiki page may also be helpful – in particular the sections starting with "Troubleshooting".

Prerequisites

Cloud development environments have fewer prerequisites than local development. All you need to do is fork this repository and install the Gitpod browser extension.

Getting Started

After installing the Gitpod plugin, refresh the page you have with your fork open (something like https://github.com/brianjaustin/otwarchive but replace brianjaustin with your GitHub username). You should now see a green button that says "Open". Click it to launch the development workspace.

By default, Gitpod will launch a version of VS Code in your browser, but that is configurable if you wish to use another IDE like locally-installed VS Code or RubyMine. Once the page loads, it will run the Docker initialization script automatically to set up your environment. This can take a few minutes the first time. Once it is complete, Gitpod will try to open a new tab with the version of otwarchive running in your development workspace. Most browsers block popups by default, so you will likely need to allow that (Firefox instructions | Chrome instructions).

Congratulations, you have your own copy of the Archive to play around with! 🎉 You can change the files in Gitpod, reload the Archive page, and watch as your change is reflected. (Note: some changes require the application to be restarted, which is documented in the Docker wiki page.)