wide/README.md

151 lines
5.8 KiB
Markdown
Raw Normal View History

2014-12-03 12:44:07 +03:00
# Wide [![Build Status](https://img.shields.io/travis/b3log/wide.svg)](https://travis-ci.org/b3log/wide) [![Apache License](http://img.shields.io/badge/license-ALv2-orange.svg)](http://www.apache.org/licenses/LICENSE-2.0) [![API Documentation](http://img.shields.io/badge/api-Godoc-blue.svg)](http://godoc.org/github.com/b3log/wide) [![Download](http://img.shields.io/badge/download-1K-red.svg)](http://pan.baidu.com/s/1dD3XwOT)
2014-11-28 04:55:58 +03:00
2014-12-04 08:51:11 +03:00
_Have a [**try**](http://wide.b3log.org/signup) first, and then help us to make it [happen](http://igg.me/at/widehub)!_
2014-08-18 17:45:43 +04:00
2014-09-08 16:31:31 +04:00
## Intro
2014-09-17 16:37:35 +04:00
2014-10-28 10:27:55 +03:00
A <b>W</b>eb-based <b>IDE</b> for Teams using Golang.
2014-08-18 17:45:43 +04:00
2014-12-02 15:58:57 +03:00
![Hello, 世界](https://cloud.githubusercontent.com/assets/873584/4606377/d0ca3c2a-521b-11e4-912c-d955ab05850b.png)
2014-10-12 18:17:35 +04:00
2014-09-08 16:31:31 +04:00
## Motivation
2014-09-26 05:56:14 +04:00
2014-09-26 05:59:22 +04:00
* **Team** IDE:
2014-11-01 15:48:26 +03:00
* _Safe and reliable_: the project source code stored on the server in real time, the developer's machine crashes without losing any source code
* _Unified environment_: server unified development environment configuration, the developer machine without any additional configuration
* _Out of the box_: 5 minutes to setup a server then open browser to develop, debug
* _Version Control_: each developer has its own source code repository, easy sync with the trunk
2014-10-28 10:28:46 +03:00
* **Web-based** IDE:
2014-09-26 05:59:22 +04:00
* Developer needs a browser only
* Cross-platform, even on mobile devices
2014-10-29 16:42:22 +03:00
* Easy to extend
* Easy to integrate with other systems
2014-09-26 05:59:22 +04:00
* For the geeks
* A try for commercial-open source: versions customized for enterprises, close to their development work flows respectively
* Currently more popular Go IDE has some defects or regrets:
* Text editor (vim/emacs/sublime/Atom, etc.): For the Go newbie is too complex
* Plug-in (goclipse, etc.): the need for the original IDE support, not professional
* LiteIDE: no modern user interface :p
* No team development experience
* There are a few of GO IDEs, and no one developed by Go itself, this is a nice try
2014-09-08 16:17:04 +04:00
2014-09-08 16:31:31 +04:00
## Features
2014-09-26 05:53:26 +04:00
2014-12-01 05:53:43 +03:00
* [X] Code Highlight, Folding: Go/HTML/JavaScript/Markdown etc.
* [X] Autocomplete: Go/HTML etc.
* [X] Format: Go/HTML/JSON etc.
* [X] Build & Run
* [X] Multiplayer: a real team development experience
* [X] Navigation, Jump to declaration, Find usages, File search etc.
* [X] Shell: run command on the server
* [X] Web development: Frontend devlopment (HTML/JS/CSS) all in one
* [X] Go tool: go get/install/fmt etc.
2014-12-01 05:59:42 +03:00
* [X] File Import & Export
2014-12-01 06:01:35 +03:00
* [X] Themes
2014-12-09 11:35:12 +03:00
* [ ] Debug
* [ ] Git integration: git command on the web
## Demos
* **Overview**
2014-12-16 11:51:31 +03:00
![Overview](https://cloud.githubusercontent.com/assets/873584/5450620/1d51831e-8543-11e4-930b-670871902425.png)
* **Goto File**
![Goto File](https://cloud.githubusercontent.com/assets/873584/5450616/1d495da6-8543-11e4-9285-f9d9c60779ac.png)
* **Autocomplete**
![Autocomplete](https://cloud.githubusercontent.com/assets/873584/5450619/1d4d5712-8543-11e4-8fe4-35dbc8348a6e.png)
2014-12-09 11:35:12 +03:00
* **Theme**
2014-12-16 11:51:31 +03:00
![4](https://cloud.githubusercontent.com/assets/873584/5450617/1d4c0826-8543-11e4-8b86-f79a4e41550a.png)
* **Show Expression Info**
![Show Expression Info](https://cloud.githubusercontent.com/assets/873584/5450618/1d4cd9f4-8543-11e4-950f-121bd3ff4a39.png)
* **Build Error Info**
![Build Error Info](https://cloud.githubusercontent.com/assets/873584/5450632/3e51cccc-8543-11e4-8ca8-8d2427aa16b8.png)
2014-08-18 17:45:43 +04:00
2014-09-26 05:53:26 +04:00
## Architecture
### Build & Run
![Build & Run](https://cloud.githubusercontent.com/assets/873584/4389219/3642bc62-43f3-11e4-8d1f-06d7aaf22784.png)
2014-09-26 05:52:10 +04:00
2014-09-26 06:00:06 +04:00
* A browser tab corresponds to a Wide session
* Execution output push via WebSocket
2014-09-26 05:38:46 +04:00
2014-09-26 06:04:30 +04:00
Flow:
1. Browser sends ````Build```` request
2. Server executes ````go build```` command via ````os/exec````<br/>
2.1. Generates a executable file
3. Browser sends ````Run```` request
4. Server executes the file via ````os/exec````<br/>
4.1. A running process<br/>
4.2. Execution output push via WebSocket channel
5. Browser renders with callback function ````ws.onmessage````
2014-09-26 05:38:46 +04:00
2014-09-25 07:03:53 +04:00
### Code Assist
2014-09-26 05:44:09 +04:00
![Code Assist](https://cloud.githubusercontent.com/assets/873584/4399135/3b80c21c-4463-11e4-8e94-7f7e8d12a4df.png)
2014-09-26 06:00:06 +04:00
* Autocompletion
2014-12-09 11:35:12 +03:00
* Find Usages/Jump To Declaration/etc.
2014-09-26 05:38:46 +04:00
2014-09-26 06:04:30 +04:00
Flow:
2014-09-26 06:05:08 +04:00
1. Browser sends code assist request
2. Handler gets user workspace of the request with HTTP session
3. Server executes ````gocode````/````ide_stub````<br/>
3.1 Sets environment variables (e.g. ${GOPATH})<br/>
3.2 ````gocode```` with ````lib-path```` parameter
2014-09-26 05:38:46 +04:00
2014-09-11 09:32:47 +04:00
## Documents
2014-09-20 06:23:45 +04:00
2014-10-11 07:42:55 +04:00
* [用户指南](http://88250.gitbooks.io/wide-user-guide)
* [开发指南](http://88250.gitbooks.io/wide-dev-guide)
2014-09-11 09:32:47 +04:00
2014-10-30 04:17:50 +03:00
## Setup
2014-09-26 05:56:14 +04:00
2014-10-30 04:17:50 +03:00
### Download Binary
We have provided OS-specific executable binary as follows:
* linux-amd64/386
* windows-amd64/386
* darwin-amd64/386
2014-11-16 11:57:48 +03:00
Download [HERE](http://pan.baidu.com/s/1dD3XwOT)!
2014-10-30 04:17:50 +03:00
### Build Wide for yourself
2014-11-16 11:57:48 +03:00
1. [Download](https://github.com/b3log/wide/archive/master.zip) source or by `git clone`
2014-10-30 04:17:50 +03:00
2. Get dependencies with
2014-11-20 08:20:21 +03:00
* `go get`
* `go get github.com/88250/ide_stub`
* `go get github.com/nsf/gocode`
2014-10-30 04:17:50 +03:00
3. Compile wide with `go build`
2014-08-18 17:45:43 +04:00
2014-11-18 11:38:49 +03:00
### Docker
1. Get image: `sudo docker pull 88250/wide:latest`
2014-11-20 11:40:39 +03:00
2. Run: `sudo docker run -u wide -p {ip}:{port}:7070 88250/wide:latest ./wide -docker=true -channel=ws://{ip}:{port}`
2014-11-18 11:38:49 +03:00
2014-09-08 16:27:54 +04:00
## Known Issues
2014-09-26 05:56:14 +04:00
2014-09-26 05:59:22 +04:00
* [Shell is not available on Windows](https://github.com/b3log/wide/issues/32)
2014-09-08 16:27:54 +04:00
2014-09-08 16:31:31 +04:00
## License
2014-09-26 05:56:14 +04:00
2014-08-18 17:51:03 +04:00
Copyright (c) 2014, B3log Team (http://b3log.org)
2014-08-18 17:45:43 +04:00
2014-08-18 17:51:03 +04:00
Licensed under the [Apache License 2.0](https://github.com/b3log/wide/blob/master/LICENSE).
2014-08-18 17:45:43 +04:00
2014-09-08 16:31:31 +04:00
## Credits
2014-09-26 05:56:14 +04:00
2014-09-26 05:59:22 +04:00
* [golang](http://golang.org)
* [CodeMirror](https://github.com/marijnh/CodeMirror)
* [zTree](https://github.com/zTree/zTree_v3)
* [LiteIDE](https://github.com/visualfc/liteide)
* [gocode](https://github.com/nsf/gocode)
* [Gorilla](https://github.com/gorilla)
* [GoBuild](http://gobuild.io)
2014-11-18 11:38:49 +03:00
* [Docker](https://docker.com)
2014-10-12 18:33:14 +04:00
----
<img src="https://cloud.githubusercontent.com/assets/873584/4606328/4e848b96-5219-11e4-8db1-fa12774b57b4.png" width="256px" />