Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Devcontainer configs #15

Merged
merged 4 commits into from
Sep 17, 2024

Conversation

nelson-lojo
Copy link
Contributor

@nelson-lojo nelson-lojo commented May 27, 2024

Added configuration to launch a devcontainer with Prairielearn launched simultaneously. The primary benefit of this is to enable demos/development without installing docker (or even an IDE!) locally -- see "Run in the cloud" below.

Run in the cloud / browser:
Screenshot 2024-06-12 at 10 58 32 AM

  1. Click the "Code" dropdown on the page of this branch (will also work on master once merged)
  2. Click the "Codespaces" tab
  3. Click the "+" to create a new codespace
  4. You will be dropped into a VSCode web editor
    • If you prefer your local IDE, then you can connect to the codespace via an extension (vscode | intellij)

Run locally:
0. Have docker installed (desktop | headless) and (if you installed docker engine) your user given docker execution/configuration permissions

  1. Open this repo in your IDE
  2. Launch the devcontainer as supported by your IDE
    • VSCode:

      1. Install the Devcontainers extension Screenshot 2024-06-12 at 11 05 03 AM
      2. Open the Command Pallet (Ctrl+Shift+P (Windows,Linux) or Cmd+Shift+P (Mac)) and select "Dev Containers: Reopen in Container" Screenshot 2024-06-12 at 11 07 59 AM
    • IntelliJ: see their docs

    • Other IDEs will likely require the devcontainers cli and a remote (similar to ssh) connection to the started container. This process is rather involved and somewhat unstable as of 12 June 2024. If your IDE supports it, I recommend connecting to a codespace as detailed above ("Run in the cloud").

@SybelBlue SybelBlue merged commit 6ab358f into ace-lab:master Sep 17, 2024
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants