Getting Started¶
Choose your setup method. Codespaces is recommended — it works in your browser, no local installation needed.
Option 1: GitHub Codespaces (Recommended)¶
- Go to the repository on GitHub
- Click "Fork" (top right) → Click "Create fork"
- On your fork, click "Code" → "Codespaces" → "Create codespace on main"
- Wait for the DevContainer to build (~3-5 minutes the first time)
- When the terminal appears, run:
- If you see
1 test, 1 passed— you're ready!
What happens during setup?¶
The DevContainer automatically:
- Installs Python 3.12 and Node.js 22
- Installs uv (our package manager)
- Runs uv sync --locked (installs Robot Framework, Browser Library, etc.)
- Runs rfbrowser init chromium (downloads Chromium browser, ~250MB)
- Runs the environment check script
Option 2: Local VSCode + Docker (DevContainer)¶
If you prefer running locally:
- Install Docker Desktop
- Install VS Code
- Install the Dev Containers extension
- Clone the repo:
- Open in VS Code → Click "Reopen in Container" when prompted
- Wait for the build to complete
- Run:
Option 3: Local Without Docker¶
For native setup (Linux/macOS/WSL):
- Install Python 3.12+: https://www.python.org/downloads/
- Install Node.js 22+: https://nodejs.org/
- Install uv:
- Clone and set up:
- Verify:
For Windows-specific instructions, see Windows Setup.
Verify Your Setup¶
Regardless of your setup method, run the environment check:
This checks all 11 prerequisites and shows actionable fix instructions for any issues.