github.🏄‍♂️

🏄‍♂️ Surf your repository like a pro

Features

TL;DR Jump to demo

• ✅ Github support - Surf GitHub repository on browser with vscode environment
• ✅ Official Chrome extension - Launch surf with extension button
• ✅ Official CLI - surf . command for opening surf on terminal
• Gitlab support (gitlab.surf) (enhance)
• Bitbucket support (bitbucket.surf) (enhance)
• surf.codes for private, custom scm (enhance)
• Remote compile & terminal support in browser (comming soon)

Chrome extension

Download our official chrome here (It's currently under review)

Building and installing chrome extension on your own

🏄‍♂️ surf CLI

Like vscode's code ., we support our command surf

# === install the cli ===
npm -g install @bridged.xyz/surf
		# or with yarn
		yarn global add @bridged.xyz/surf

# and surf 🏄 !
surf .

You can use this as you sub editor, which can be useful when you're exploring your master/main repository when you are at your own branch on your local machine

# different branch
surf -b <branch-name>

Learn more at surf-cli

Notes

For unlimited usage, you must provide github token in key icon tab

You can generate new token for github.surf on here

Limitations

Max requests per hour

• github - 60 requests per hour if no token provided (5000 when provided)
• gitlab - 5 reqests per minute
• bitbucket - 60 requests per hour

Learn more about providing a token for unlimited usage

Github Enterprise usage

You have to modify api.ts and deploy as-your-own via Deploy on vercel button on the top of this document. api.guthub.com shall point to your-server.example.com

Supported languages / frameworks extensions (themes)

As listed here and surf-code-extensions here, we support below extensions in-the-box

• Vue
• JS/TS/JSX/TSX (React, Svelete, and other js based frrameworks)
• Dart & Flutter
• Elm
• Kotlin
• Scala
• Ocaml
• Vetur
• Jupyter Notebook - deepmind/deepmind-research demo
• Material theme

What's Next?

• PWA Support
• Enterprise account support (github enterprise)
• Cusom extensions support
• Mobile screen support
• Remote cli & build support
• More powerful Private repository experience

Remote compile / App preview (for ui applications) & CLI Capabilities.

For repositories containing project such like flutter, react and other main ui frameworks we are planning to suport live-compile-preview feature of the application. the main issue with this will be the pricing and performance limitation. since we are going to keep this project free / fast for everyone

The technology behind this is under development in appbox and console. you can see the remote-compile demo on assistant

Contribution

Join the community

• join slack - here on notion
• view design - here on figma
• view the project board - here on github

Learn more about contribution at CONTRIBUTING.md

Disclamer

this project is inspired from cdr/code-server and conwnet/github1s. the base code was forked from github1s (MIT License at the point of fork), which we are replacing it with our own implementations and approaches.

See Also

• surf.codes
• surf-code-extensions

References & Blogs / Translations

References

• cdr/code-server
• microsoft/vscode
• conwnet/github1s
• bridgedxyz/node-services
• bridgedxyz/assistant
• bridgedxyz/console.bridged.xyz
• bridgedxyz/appbox

Blogs / Translations

• 🌍 - 🏄‍♂️ Introducing github.surf Fastest and most elegant way to surf your code (CLI, Extension included)
• 🇰🇷 - (ko) 🏄‍♂️ Github.surf 를 소개합니다! — 코드를 서핑하기 가장 빠르고 쿨한 방법 (CLI, Extension 지원)
• 🇩🇪 - WIP
• 🇨🇳 - WIP