prabhjotsl / ungit

The easiest way to use git. On any platform. Anywhere.

ungit

The easiest way to use git. On any platform. Anywhere.

• 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 (view, checkout and push changes from/to gerrit).

Quick intro to ungit: http://youtu.be/hkBVAi3oKvo

Installing

Requires node.js (≥ 0.10), npm (≥ 1.3.1) and git.

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.

Bugs

You can help out by enabling bugtracking in the config (set "bugtracking": true, see config section below): this will make ungit send an anonymous bugreport every time it crashes, which makes it much easier to know what problems users are experiencing.

Configure

Put a configuration file called .ungitrc in your home directory (/home/USERNAME on *nix, C:/Users/USERNAME/ on windows). Can be in either json or ini format. See source/config.js for available options.

Example of ~/.ungitrc configuration file to change default port and enable bugtracking:

{
	"port": 8080,
	"bugtracking": true
}

Developing

If you decide to install by cloning the repo, make sure to run npm install then grunt after cloning (to fetch dependencies, build concatenated files and compile less). If you haven't already, you can install grunt by running npm install -g grunt-cli.

Once you've done that, you can start ungit by running npm start. Run the tests with npm test.

License (MIT)

Copyright (C) 2013 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.