https://github.com/surfcodes/surf
๐โโ๏ธ Surf GitHub code with VS Code. (with CLI, chrome extensions, also works for Gitlab)
https://github.com/surfcodes/surf
code-server github github1s surf
Last synced: 5 months ago
JSON representation
๐โโ๏ธ Surf GitHub code with VS Code. (with CLI, chrome extensions, also works for Gitlab)
- Host: GitHub
- URL: https://github.com/surfcodes/surf
- Owner: surfcodes
- License: apache-2.0
- Created: 2023-12-13T17:46:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-13T17:55:18.000Z (over 1 year ago)
- Last Synced: 2024-08-03T01:30:06.852Z (9 months ago)
- Topics: code-server, github, github1s, surf
- Language: TypeScript
- Homepage: https://github.surf
- Size: 259 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-list - surf
README
# ๐โโ๏ธ surf.
> ๐โโ๏ธ Surf your repository like a pro
> โ๏ธ 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.
## Features
[**TL;DR Jump to demo**](https://github.surf)
- โ
Github support - Surf GitHub repository on browser with vscode environment
- โ
Gist support - Surf Gist repository on browser with vscode environment ([DEMO](https://gist.github.surf/softmarshmallow/9659717bf0a876940b65ee3cdaef0655))
- โ
[Official Chrome extension][chrome_link] - Launch surf with extension button
- โ
Official CLI - `surf .` command for opening surf on terminal
- โ
Gitlab support ([gitlab.surf](https://gitlab.surf))
- Bitbucket support (under development) ([bitbucket.surf](https://bitbucket.surf))
- [surf.codes](https://surf.codes) for private, custom scm (enhance)
- Remote compile & terminal support in browser (comming soon)
## Chrome extension
Download our official chrome [here](chrome_link) (It's currently under review)
[Building and installing chrome extension on your own](./chrome-extension/README.md)
**This also works for the GIST too**
## ๐โโ๏ธ `surf` CLI
Like vscode's `code .`, we support our command `surf`
```shell
# === 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 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
```sh
# different branch
surf -b
```
Learn more at [surf-cli](https://github.com/bridgedxyz/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](https://github.com/settings/tokens/new?scopes=repo&description=githubsurf)
## Limitations
**Max requests per hour**
- [github](https://docs.github.com/en/rest/reference/rate-limit) - 60 requests per hour if no token provided (5000 when provided)
- [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**
- [bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/api-request-limits/) - 60 requests per hour
[Learn more about providing a token for unlimited usage](./docs/guide.md)
**Github Enterprise usage**
You 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
## Supported languages / frameworks extensions (themes)
[As listed here](./extensions) and [surf-code-extensions](https://github.com/bridgedxyz/surf-code-extensions) here, we support below extensions in-the-box
- Vue
- JS/TS/JSX/TSX (React, Svelte, and other js based frameworks)
- Dart & Flutter
- Elm
- Kotlin
- Scala
- Ocaml
- Vetur
- Jupyter Notebook - [deepmind/deepmind-research demo](https://github.surf/deepmind/deepmind-research)
- Material theme
## What's Next?
- PWA Support
- Enterprise account support (github enterprise)
- Custom 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](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)
## Contribution
### Join the community
- join slack - [here on notion](https://www.notion.so/bridgedxyz/Bridged-OSS-Community-c6983f668e3e4204aed8856da0e73483)
- view design - [here on figma](https://www.figma.com/file/R3U3OHaoPVd4D7Z9mcaqIE/github.surf?node-id=14%3A0)
- view the project board - [here on github](https://github.com/bridgedxyz/github.surf/projects)
Learn more about contribution at [CONTRIBUTING.md](./CONTRIBUTING.md)
## Disclaimer
This 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.
## See Also
- [surf.codes](https://surf.codes)
- [surf-code-extensions](https://github.com/bridgedxyz/surf-code-extensions)
## References & Blogs / Translations
**References**
- [cdr/code-server](https://github.com/cdr/code-server)
- [microsoft/vscode](https://github.com/microsoft/vscode)
- [conwnet/github1s](https://github.com/conwnet/github1s)
- [bridgedxyz/node-services](https://github.com/bridgedxyz/node-services)
- [bridgedxyz/assistant](https://github.com/bridgedxyz/assistant)
- [bridgedxyz/console.bridged.xyz](https://github.com/bridgedxyz/console.bridged.xyz)
- [bridgedxyz/appbox](https://github.com/bridgedxyz/appbox)
**Blogs / Translations**
- ๐ - [๐โโ๏ธ 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)
- ๐ฐ๐ท - [(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)
- ๐ฏ๐ต - [(๐ฏ๐ต)๐โโ๏ธ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)
- ๐ฉ๐ช - WIP
- ๐จ๐ณ - WIP
[![get-chrome-ext][chrome_badge]][chrome_link]
[![get-firefox-addon][firefox_badge]][firefox_link]
[chrome_link]: https://chrome.google.com/webstore/detail/aipkghikndfblkikafmbahbekkhmppia
[chrome_badge]: ./branding/badges/chrome-badge.png
[firefox_link]: https://addons.mozilla.org/firefox/addon/
[firefox_badge]: ./branding/badges/firefox-badge.png
