generated from github/codespaces-react
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
1 / 11 of 1 issue completedLabels
documentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is neededquestionFurther information is requestedFurther information is requestedwontfixThis will not be worked onThis will not be worked on
Description
Based on the search results, here's a structured overview of GitHub Codespaces documentation and key features:
⚙️ 1. Core Documentation Resources
- Official GitHub Docs: Comprehensive guides for setup, configuration, and management .
- Includes project setup with
devcontainer.json, port forwarding, secrets management, and prebuild configurations. - Language-specific guides (Node.js, Python, Java, etc.) for custom environments .
- Includes project setup with
- VS Code Integration: Detailed usage for browser/desktop editors, customization, and limitations .
🚀 2. Key Features & Use Cases
- Instant Cloud Dev Environments:
- Spin up preconfigured environments via repo, PR, or commit .
- Supports VS Code, JetBrains IDEs, JupyterLab, and browser editors .
- Customization:
- Per-Project: Configure OS, tools, ports, and extensions via
devcontainer.json. - Per-User: Sync personal settings (e.g.,
.bashrc, themes) via dotfiles repository .
- Per-Project: Configure OS, tools, ports, and extensions via
- Collaboration:
- Real-time pair programming with VS Code Live Share .
- Port sharing for feedback/testing (scope-controlled by policies) .
- Education & OSS:
- Free tiers for students (180 core-hrs/month) and open-source maintainers .
- GitHub Classroom integration with educator allowances .
⚒️ 3. Setup & Configuration
- Quick Start:
- Click
<> Code→Create codespacein any GitHub repo . - Use templates (e.g., SuperAGI) for prebuilt environments .
- Click
- Advanced Config:
- Prebuilds: Accelerate launch times by pre-configuring dependencies .
- Machine Types: Scale from 2-core to 32-core VMs .
- Secrets Management: Sync environment variables via Doppler or GitHub secrets .
💰 4. Cost & Policies
- Pricing:
User Type Free Tier Beyond Free Tier Individuals 120 core-hrs/month Pay-as-you-go Organizations N/A Pay-as-you-go + usage caps - Timeout & Storage:
- Default inactivity timeout: 30 mins (configurable up to 240 mins) .
- Storage: 15 GB free/month, then $0.18/GB-month .
- Org Controls: Admin policies for machine types, base images, and timeouts .
⚠️ 5. Limitations & Workarounds
- No Self-Hosting: Runs exclusively on GitHub infrastructure .
- Web Editor Constraints:
- Keyboard shortcut conflicts (e.g.,
Ctrl+Wcloses browser tabs) . - Limited extension support (e.g., language packs, debuggers) .
- Workaround: Use desktop VS Code for full functionality .
- Keyboard shortcut conflicts (e.g.,
- Flutter/iOS Development:
- No Android/iOS emulation or USB device detection .
- Workaround: Local development for mobile projects .
🔒 6. Security Highlights
- Isolation: VM-based containers with encrypted data .
- Compliance: Region-specific data residency controls .
- GPG Signing: Automatic commit verification .
📚 7. Learning Resources
- Guides: Disaster recovery, security architecture .
- Courses: LinkedIn Learning (free until 2023) and DataCamp tutorials .
For full details, explore the official documentation .
Sazwanismail
Sub-issues
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is neededquestionFurther information is requestedFurther information is requestedwontfixThis will not be worked onThis will not be worked on
Projects
Status
No status