{"id":13727039,"url":"https://github.com/surfcodes/surf","last_synced_at":"2025-05-07T22:30:54.470Z","repository":{"id":212346898,"uuid":"731269016","full_name":"surfcodes/surf","owner":"surfcodes","description":"🏄‍♂️ Surf GitHub code with VS Code. (with CLI, chrome extensions, also works for Gitlab)","archived":false,"fork":false,"pushed_at":"2023-12-13T17:55:18.000Z","size":272080,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-14T17:47:57.527Z","etag":null,"topics":["code-server","github","github1s","surf"],"latest_commit_sha":null,"homepage":"https://github.surf","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/surfcodes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-12-13T17:46:45.000Z","updated_at":"2024-10-05T07:11:59.000Z","dependencies_parsed_at":"2024-01-06T07:54:03.252Z","dependency_job_id":null,"html_url":"https://github.com/surfcodes/surf","commit_stats":null,"previous_names":["surfcodes/surf"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surfcodes%2Fsurf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surfcodes%2Fsurf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surfcodes%2Fsurf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surfcodes%2Fsurf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/surfcodes","download_url":"https://codeload.github.com/surfcodes/surf/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252965210,"owners_count":21832839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-server","github","github1s","surf"],"created_at":"2024-08-03T01:03:36.801Z","updated_at":"2025-05-07T22:30:49.455Z","avatar_url":"https://github.com/surfcodes.png","language":"TypeScript","readme":"# 🏄‍♂️  surf.\n\n\n\n\u003cp align=\"center\"\u003e\u003cimage src=\"branding/logo.png\"/\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\u003ca href=\"https://github.surf\"\u003e\u003cimage src=\"branding/url-example.png\"/\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003e 🏄‍♂️ Surf your repository like a pro\n\n\n\u003e ❗️ This repo is forked from Github1s. If you are looking for github1s.com, please visit [here](https://github.com/conwnet/github1s). Please note that most of the code / work is done by conwnet and github1s contributors (more details below), and we are happy to use the original implementations to modify with more customizations.\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@bridged.xyz/surf\" style=\"border-right: 1px solid #4D4D4D\"\u003e\n    \u003cimage alt=\"surf cli on npm\" src=\"https://img.shields.io/badge/cli-latest-brightgreen\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://vercel.com/new/git/external?repository-url=https://github.com/bridgedxyz/github.surf\u0026project-name=github.surf\u0026repo-name=github.surf\" style=\"border-right: 1px solid #4D4D4D\"\u003e\n    \u003cimage alt=\"Deploy github.surf with Vercel\" src=\"https://vercel.com/button\"/\u003e\n  \u003c/a\u003e\n\t\u003ca href=\"https://www.producthunt.com/posts/github-surf?utm_source=badge-featured\u0026utm_medium=badge\u0026utm_souce=badge-github-surf\" target=\"_blank\" style=\"border-right: 1px solid #4D4D4D\"\u003e\u003cimg src=\"https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=284549\u0026theme=light\" alt=\"GitHub Surf - Open repositories in a VSCode environment in your browser | Product Hunt\" style=\"width: 250px; height: 54px;\" width=\"250\" height=\"54\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://twitter.com/intent/tweet?text=Wow:\u0026url=https%3A%2F%2Fgithub.com%2Fbridgedxyz%2Fgithub.surf\" style=\"border-right: 1px solid #4D4D4D\"\u003e\n    \u003cimage alt=\"Twitter\" src=\"https://img.shields.io/twitter/url?style=social\u0026url=https%3A%2F%2Fgithub.com%2Fbridgedxyz%2Fgithub.surf\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/bridgedxyz/github.surf/blob/main/LICENSE\"\u003e\n    \u003cimage alt=\"GitHub license\" src=\"https://img.shields.io/github/license/bridgedxyz/github.surf\"\u003e\n \u003c/a\u003e\n\u003c/p\u003e\n\n## Features\n\n![github.surf](./docs/images/github-surf-browser-preview.png)\n\n[**TL;DR Jump to demo**](https://github.surf)\n\n- ✅ Github support - Surf GitHub repository on browser with vscode environment\n- ✅ Gist support - Surf Gist repository on browser with vscode environment ([DEMO](https://gist.github.surf/softmarshmallow/9659717bf0a876940b65ee3cdaef0655))\n- ✅ [Official Chrome extension][chrome_link] - Launch surf with extension button\n- ✅ Official CLI - `surf .` command for opening surf on terminal\n- ✅ Gitlab support ([gitlab.surf](https://gitlab.surf))\n- Bitbucket support (under development) ([bitbucket.surf](https://bitbucket.surf))\n- [surf.codes](https://surf.codes) for private, custom scm (enhance)\n- Remote compile \u0026 terminal support in browser (comming soon)\n\n\n\n\n\n## Chrome extension\n\nDownload our official chrome [here](chrome_link) (It's currently under review)\n\n![surf chrome extension](./docs/gifs/surf-extension-chrome-demo.gif)\n\n[Building and installing chrome extension on your own](./chrome-extension/README.md)\n\n**This also works for the GIST too**\n\n![gist surf](./docs/gifs/gist-surf-chrome-demo.gif)\n\n\n\n## 🏄‍♂️ `surf` CLI\n\n\u003cp align=\"center\"\u003e\u003cimage src=\"./branding/surf-cli-cover.png\"/\u003e\u003c/p\u003e\n\n\n\n\u003cp align=\"center\"\u003e\u003cimage src=\"./docs/gifs/cli-demo.gif\"/\u003e\u003c/p\u003e\n\nLike vscode's `code .`, we support our command `surf`\n\n```shell\n# === install the cli ===\nnpm -g install @bridged.xyz/surf\n\t\t# or with yarn\n\t\tyarn global add @bridged.xyz/surf\n\n# and surf 🏄 !\nsurf .\n```\n\nYou can use this as your 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\n\n```sh\n# different branch\nsurf -b \u003cbranch-name\u003e\n```\n\n\n\nLearn more at [surf-cli](https://github.com/bridgedxyz/surf-cli)\n\n\n\n\n\n## Notes\n\nFor unlimited usage, you must provide github token in `key` icon tab\n\nYou can generate new token for github.surf on [here](https://github.com/settings/tokens/new?scopes=repo\u0026description=githubsurf)\n\n![provide oauth token for unlimited usage on github.surf](./docs/images/tutorial-provide-oauth-token.png)\n\n\n\n## Limitations\n\n**Max requests per hour**\n\n- [github](https://docs.github.com/en/rest/reference/rate-limit) - 60 requests per hour if no token provided (5000 when provided)\n- [gitlab](https://docs.gitlab.com/ee/security/rate_limits.html#:~:text=Introduced%20in%20GitLab%2012.9.,requests%20per%20minute%20per%20user.) - 5 requests per **minute**\n- [bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/api-request-limits/) - 60 requests per hour\n\n[Learn more about providing a token for unlimited usage](./docs/guide.md)\n\n\n\n**Github Enterprise usage**\n\nYou have to modify [api.ts](https://github.com/bridgedxyz/github.surf/blob/main/extensions/githubsurf/src/api.ts) and deploy as-your-own via Deploy on vercel button on the top of this document. api.github.com shall point to your-server.example.com\n\n\n\n## Supported languages / frameworks extensions (themes)\n\n[As listed here](./extensions) and [surf-code-extensions](https://github.com/bridgedxyz/surf-code-extensions) here, we support below extensions in-the-box\n\n- Vue\n- JS/TS/JSX/TSX (React, Svelte, and other js based frameworks)\n- Dart \u0026 Flutter\n- Elm\n- Kotlin\n- Scala\n- Ocaml\n- Vetur\n- Jupyter Notebook - [deepmind/deepmind-research demo](https://github.surf/deepmind/deepmind-research)\n- Material theme\n\n\n\n## What's Next?\n\n- PWA Support\n- Enterprise account support (github enterprise)\n- Custom extensions support\n- Mobile screen support\n- Remote cli \u0026 build support\n- More powerful Private repository experience\n\n\n\n## Remote compile / App preview (for ui applications) \u0026 CLI Capabilities.\n\nFor 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.\n\nThe technology behind this is under development in [appbox](https://github.com/bridgedyxz/appbox) and [console](https://github.com/bridgedxyz/console.bridged.xyz). You can see the remote-compile demo on [assistant](https://github.com/bridgedxyz/assistant)\n\n\n\n\n## Contribution\n\n### Join the community\n\n- join slack - [here on notion](https://www.notion.so/bridgedxyz/Bridged-OSS-Community-c6983f668e3e4204aed8856da0e73483)\n- view design - [here on figma](https://www.figma.com/file/R3U3OHaoPVd4D7Z9mcaqIE/github.surf?node-id=14%3A0)\n- view the project board - [here on github](https://github.com/bridgedxyz/github.surf/projects)\n\nLearn more about contribution at [CONTRIBUTING.md](./CONTRIBUTING.md)\n\n\n\n## Disclaimer\n\nThis project is inspired from [cdr/code-server](https://github.com/cdr/code-server) and [conwnet/github1s](https://github.com/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.\n\n\n\n## See Also\n\n- [surf.codes](https://surf.codes)\n- [surf-code-extensions](https://github.com/bridgedxyz/surf-code-extensions)\n\n\n\n\n\n## References \u0026 Blogs / Translations\n\n**References**\n\n- [cdr/code-server](https://github.com/cdr/code-server)\n- [microsoft/vscode](https://github.com/microsoft/vscode)\n- [conwnet/github1s](https://github.com/conwnet/github1s)\n- [bridgedxyz/node-services](https://github.com/bridgedxyz/node-services)\n- [bridgedxyz/assistant](https://github.com/bridgedxyz/assistant)\n- [bridgedxyz/console.bridged.xyz](https://github.com/bridgedxyz/console.bridged.xyz)\n- [bridgedxyz/appbox](https://github.com/bridgedxyz/appbox)\n\n**Blogs / Translations**\n\n![medium github surf](./branding/blog-cover.png)\n\n- 🌍 - [🏄‍♂️ Introducing github.surf Fastest and most elegant way to surf your code (CLI, Extension included)](https://medium.com/bridgedxyz/%EF%B8%8F-introducing-github-surf-bcc8ef9bf594)\n- 🇰🇷 - [(ko) 🏄‍♂️ Github.surf 를 소개합니다! — 코드를 서핑하기 가장 빠르고 쿨한 방법 (CLI, Extension 지원)](https://medium.com/bridgedxyz/ko-%EF%B8%8F-github-surf%EB%A5%BC-%EC%86%8C%EA%B0%9C%ED%95%A9%EB%8B%88%EB%8B%A4-%EC%BD%94%EB%93%9C%EB%A5%BC-%EC%84%9C%ED%95%91%ED%95%98%EA%B8%B0-%EA%B0%80%EC%9E%A5-%EB%B9%A0%EB%A5%B4%EA%B3%A0-%EC%BF%A8%ED%95%9C-%EB%B0%A9%EB%B2%95-cli-extension-%EC%A7%80%EC%9B%90-65e6a9a07bd5)\n- 🇯🇵 - [(🇯🇵)🏄‍♂️Github.surfを紹介します! — コードをサーフィンするに一番早くてクールな方法(CLI、Extensionの支援)](https://medium.com/bridgedxyz/%EF%B8%8Fgithub-surf%E3%82%92%E7%B4%B9%E4%BB%8B%E3%81%97%E3%81%BE%E3%81%99-%E3%82%B3%E3%83%BC%E3%83%89%E3%82%92%E3%82%B5%E3%83%BC%E3%83%95%E3%82%A3%E3%83%B3%E3%81%99%E3%82%8B%E3%81%AB%E4%B8%80%E7%95%AA%E6%97%A9%E3%81%8F%E3%81%A6%E3%82%AF%E3%83%BC%E3%83%AB%E3%81%AA%E6%96%B9%E6%B3%95-cli-extension%E3%81%AE%E6%94%AF%E6%8F%B4-a509539a9a6)\n- 🇩🇪 - WIP\n- 🇨🇳 - WIP\n\n\n\n[![get-chrome-ext][chrome_badge]][chrome_link]\n[![get-firefox-addon][firefox_badge]][firefox_link]\n\n\n[chrome_link]: https://chrome.google.com/webstore/detail/aipkghikndfblkikafmbahbekkhmppia\n[chrome_badge]: ./branding/badges/chrome-badge.png\n[firefox_link]: https://addons.mozilla.org/firefox/addon/\n[firefox_badge]: ./branding/badges/firefox-badge.png\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurfcodes%2Fsurf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsurfcodes%2Fsurf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurfcodes%2Fsurf/lists"}