# GitHub1s — Browse Any GitHub Repo in a VS Code Interface

> An open-source tool that lets you read any GitHub repository in a full VS Code editor experience by changing the URL from github.com to github1s.com.

## Install

Save as a script file and run:

# GitHub1s — Browse Any GitHub Repo in a VS Code Interface

## Quick Use
```
Take any GitHub repository URL:
  https://github.com/user/repo
Change "github.com" to "github1s.com":
  https://github1s.com/user/repo
The repo opens in a VS Code editor in your browser.
```

## Introduction
GitHub1s is a project that wraps VS Code (via the open-source code-server) to let anyone browse a GitHub repository with full editor features simply by changing the domain in the URL. It provides syntax highlighting, file search, symbol navigation, and the familiar VS Code layout without any installation.

## What GitHub1s Does
- Opens any public GitHub repository in a browser-based VS Code editor
- Provides syntax highlighting for hundreds of languages
- Enables file tree navigation and quick file switching
- Supports Go to Definition and symbol search within the repository
- Requires no sign-up, installation, or personal access token

## Architecture Overview
GitHub1s is built on top of VS Code's open-source web editor. It serves a statically hosted VS Code instance that connects to the GitHub API to fetch repository contents on demand. Files are loaded lazily as you open them, and the file tree is populated via the GitHub Trees API. The project is deployed as a static site, making it lightweight and easy to self-host.

## Self-Hosting & Configuration
- Use it instantly at github1s.com with no setup required
- Self-host by cloning the repository and running `yarn && yarn build`
- Serve the built static files with any web server like Nginx or Caddy
- Provide a GitHub token via the settings panel for higher API rate limits
- Customize themes and keybindings through VS Code's built-in settings UI

## Key Features
- Zero-install access to a full code editor for any GitHub repository
- One-character URL change transforms GitHub into a VS Code workspace
- Supports all languages with VS Code's built-in syntax highlighting
- Fast loading with lazy file fetching from the GitHub API
- Fully open source and self-hostable

## Comparison with Similar Tools
- **github.dev** — GitHub's official web editor (press `.` on any repo); GitHub1s was the original inspiration
- **Gitpod** — provides a full development environment with terminal; GitHub1s is read-only browsing
- **StackBlitz** — runs Node.js in the browser for live editing; GitHub1s is focused on reading code
- **Sourcegraph** — adds code intelligence and cross-repo search; GitHub1s offers a simpler VS Code view

## FAQ
**Q: Can I edit files and push changes with GitHub1s?**
A: No. GitHub1s is a read-only code browser. For editing, use github.dev or Codespaces.

**Q: Does it work with private repositories?**
A: You can provide a personal access token in the VS Code settings panel to access private repos.

**Q: Is there a rate limit?**
A: Yes. The GitHub API has rate limits for unauthenticated requests (60/hour). Adding a token raises this to 5,000/hour.

**Q: How is this different from pressing "." on GitHub?**
A: GitHub later added the "." shortcut (github.dev) with similar functionality. GitHub1s was the pioneering project that demonstrated the concept.

## Sources
- https://github.com/conwnet/github1s
- https://github1s.com

---
Source: https://tokrepo.com/en/workflows/asset-90441457
Author: Script Depot