wide/README.md

58 lines
2.0 KiB
Markdown
Raw Normal View History

2014-09-08 16:31:31 +04:00
# Wide
2014-08-18 17:45:43 +04:00
2014-09-08 16:31:31 +04:00
## Intro
2014-08-18 17:45:43 +04:00
A simple <b>W</b>eb **IDE** for golang.
2014-09-08 16:31:31 +04:00
## Motivation
2014-09-08 16:14:34 +04:00
* There are a few of GO IDEs, and no one developed by Go itself, this is a nice try
* Web based IDE:
* Developer needs a browser only
* Cross-platform, even on mobile devices
* For the geeks
* Team IDE:
* 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
* 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: only run one process at the same time; no modern user interface
* No team development experience
2014-09-09 05:26:38 +04:00
* A try for commercial open source: a version customized for an enterprise, coreesponding to its development work flow
2014-09-08 16:17:04 +04:00
2014-09-08 16:31:31 +04:00
## Features
2014-08-18 17:45:43 +04:00
* Code Highlight
* Autocomplete
* Format
2014-09-06 14:42:29 +04:00
* Run & Debug
2014-08-18 17:45:43 +04:00
* Multiplayer
2014-09-06 14:42:29 +04:00
* Navigation & Jump
* Shell
2014-09-06 14:43:15 +04:00
* Git integration
2014-09-06 14:48:59 +04:00
* Web development
2014-08-18 17:45:43 +04:00
2014-09-08 16:31:31 +04:00
## Demos
2014-08-28 05:29:28 +04:00
* [20140823](http://b3log.org/wide/demo/20140823.html)
2014-09-08 16:31:31 +04:00
## Setup
2014-08-18 17:45:43 +04:00
1. Downloads source
2. Compiles wide with `go build`
3. Configures `conf/wide.json`
2014-08-29 05:23:35 +04:00
4. Runs the executable `wide` or `wide.exe`
2014-08-18 17:45:43 +04:00
2014-09-08 16:27:54 +04:00
## Known Issues
* [Shell is not available on Windows](https://github.com/b3log/wide/issues/32)
2014-09-08 16:31:31 +04:00
## License
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-08-18 17:45:43 +04:00
* [golang](http://golang.org)
* [CodeMirror](https://github.com/marijnh/CodeMirror)
* [zTree](https://github.com/zTree/zTree_v3)
* [gocode](https://github.com/nsf/gocode)
* [Gorilla](https://github.com/gorilla)