Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 2.34 KB

dev-env-codespaces.md

File metadata and controls

73 lines (46 loc) · 2.34 KB

Develop Quizmaster in GutHub Codespaces

Create a Codespace

  1. Go to GitHub repo scrumdojo/quizmaster and create a Codespace.

    Create a codespace in GitHub

  2. Select Machine type with 4 cores / 16GB.

  3. The codespace opens a web version of VS Code in a new browser tab. In a few moments, a Terminal tab appears running postCreateCommand (creating DB and installing frontend dependencies). ⚠️ Wait until it successfully finishes (a few minutes)!

    Post-create command

Congratulations, you're good to go! You can either work from the browser window, or open the codespace from your VS Code.

Optional: Setup SSH access

If you want to use IntelliJ IDEA or Cursor, you need to setup SSH access to the codespace.

Config SSH

You need GitHub CLI to set it up. Install it if you haven't already.

  1. Create an SSH key (local machine)

    On your local machine, go to ~/.ssh and run:

    ssh-keygen -t rsa -b 4096 -C “[email protected]” -f ~/.ssh/quizmaster_codespace

  2. Add public key to the Codespace (in your codespace)

    In your Codespace mkdir ~/.ssh && cd ~/.ssh and add the content of ~/.ssh/quizmaster_codespace.pub from your local machine to authorized_keys.

    echo "<content of quizmaster_codespace.pub>" >> ~/.ssh/authorized_keys

  3. Configure Codespace SSH (local machine)

    gh auth login
gh codespace list
gh codespace ssh --config

    Paste the output of the last command to ~/.ssh/config on your local machine.

Connect from IntelliJ IDEA

Make sure the Codespace is running on https://github.com/codespaces.

  1. On the IntelliJ IDEA Welcome screen, select "Remote Development > SSH". Press New Project button.

  2. Copy Host from your local ~/.ssh/config (see above)

  3. Create a new Connection (cog icon on the right):

    • Host: <Host from your ~/.ssh/config>
    • Port: 2222
    • Authentication type: OpenSSH config and authentication agent
    • Username: empty
    • Password: empty

  4. Connect to the newly created Connection.

  5. In the "Choose IDE and Project" screen

    • Select IDE version (recommended latest non-RC release)
    • Select Project directory: /workspaces/quizmaster