ungit
The easiest way to use git. On any platform. Anywhere.
Git is known for being a versatile distributed source control system that is a staple of many individuals, communities, and even for the City of Chattanooga to crowd source bicycle parking locations. However, it is not known for userfriendlyness or easy learning curve.
Ungit brings user friendliness to git without sacrificing the versatility of git.
- Clean and intuitive UI that makes it easy to understand git.
- Runs on any platform that node.js & git supports.
- Web-based, meaning you can run it on your cloud/pure shell machine and use the ui from your browser (just browse to http://your-cloud-machine.com:8448).
- Works well with GitHub.
- Gerrit integration through plugin: https://github.com/FredrikNoren/ungit-gerrit
Quick intro to ungit: http://youtu.be/hkBVAi3oKvo
Installing
Requires node.js (≥ 6.11), npm (≥ 3.10.10, comes with node.js) and git (≥ 1.8.x). To install ungit just type:
npm install -g ungit
NOTE: If your system requires root access to install global npm packages, make sure you use the -H flag:
sudo -H npm install -g ungit
Using
Anywhere you want to start, just type:
ungit
This will launch the server and open up a browser with the ui.
Configuring
Put a configuration file called .ungitrc in your home directory (/home/USERNAME on *nix, C:/Users/USERNAME/ on windows). Configuration file must be in json format. See source/config.js for available options.
You can also override configuration variables at launch by specifying them as command line arguments; ungit --port=8080. To disable boolean features use --no: ungit --no-autoFetch.
Example of ~/.ungitrc configuration file to change default port and enable bugtracking:
External Merge Tools
If you have your own merge tool that you would like to use, such as Kaleidoscope or p4merge, you can configure ungit to use it. See MERGETOOL.md.
Auto Refresh
Ungit will watch git directory recursively upon page view and automatically refresh contents on git operations or changes on files that are not configured to be ignored in .gitignore.
One caveat is that node's fs.watch() with recursive: true option is only available in Mac and Windows. For non Mac and Windows machines, git operations will be automatically refreshed but file changes may require manual refreshes as fs.watch() is unable to detect changes within nested directory hierarchy.
Text Editor Integrations
- atom-ungit for Atom.io by @codingtwinky
- brackets-ungit for Brackets.io by @hirse
- Codiad-OpenUngit for Codiad by @viharm
Developing
See CONTRIBUTING.md.
Maintainers
Known issues
- If you're running MacOSX Mavericks and Ungit crashes after a few seconds; try updating npm and node. See #259 and #249 for details.
- Ubuntu users may have trouble installing because the node executable is named differently on Ubuntu, see #401 for details.
- Debian Wheezy's supported git and nodejs packages are too old, therefore download newest git and nodejs tarballs and build from source.
- Adblocker may block Ungit! Some ad blockers, such as Adblock plus and uBlock, don't like localhost api calls and assume that it is a cross domain attack. Please whitelist
{localhost|127.0.0.1|$UngitURL}:{ungit port number}. #887 #892 - Running git in non English language will result in unexpected behavior! Ungit parses git command results in English to detect repos' states and this causes confusion when git results are not in English. #959
Changelog
See CHANGELOG.md.
License (MIT)
Copyright (C) 2013-2017 Fredrik Norén
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
