Enable devcontainer for remote development on GitHub#63
Merged
DavidTorresIPA merged 9 commits intomainfrom May 28, 2025
Merged
Conversation
DavidTorresIPA
approved these changes
May 28, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Summary 🚀
What does this PR do? 📝
Creates the ability to use Codespaces on GitHub.
Why is this change needed? 🤔
We want to enable IPA staff to quickly get set up and contribute to the Knowledge Hub without having to install software on their laptops.
How was this implemented? 🛠️
Create a
.devcontainer/set up with Docker and a.devcontainer/.devcontainer.jsonthat includes Quarto, R, and Python environments such that a user can modify and build the website within a Codespace on GitHub.❗ I had to disable the
research-design/sample-size-power.qmdbecause that is dependent on Stata to execute code. If using codespaces, any Stata code will not execute. will need to run locally with your Stata installation for the time being.References for future consideration if we want to include Stata in the Codespace:
https://github.com/AEADataEditor/stata-project-with-docker
https://github.com/AEADataEditor/docker-stata
How to test or reproduce? 🧪
Go to this PR's branch: https://github.com/PovertyAction/ipa-research-data-science-hub/tree/feature/setup-devcontainer
And, on the green "Code" button, select Codespaces >> + to add a codespace.
Once the codespace is built (this may take some time ~10 mins), you should be able to open your codespace from the browser or open in VS Code.
Screenshots (if applicable) 📷
Checklist ✅
Reviewer Emoji Legend
:code::smiley::+1::100:...and I want the author to know it! This is a way to highlight positive parts of a code review.
:star: :star: :star:And I am providing reasons why it needs to be addressed as well as suggested improvements.
:star: :star:And I am providing suggestions where it could be improved either in this PR or later.
:star:...and consider this a suggestion, not a requirement.
:question:This should be a fully formed question with sufficient information and context that requires a response.
:memo::pick:This does not require any changes and is often better left unsaid. This may include stylistic, formatting, or organization suggestions and should likely be prevented/enforced by linting if they really matter
:recycle:Should include enough context to be actionable and not be considered a nitpick.