Skip to content

Commit 996e856

Browse files
committed
Add README.md
1 parent e689cc0 commit 996e856

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# gitonbrowser
2+
3+
**gitonbrowser** is a Git client on your web browser. Internally it is an express application that executes git commands behind the scenes and provides UI on any browser.
4+
One big advantage of **gitonbrowser** is that since it runs in a browser, it will provide (almost) the same experience on different OSs when used in the same browser.
5+
6+
## Requirements
7+
nodejs (https://nodejs.org)
8+
9+
## Installation
10+
1. clone or download the repository anywhere on your computer.
11+
2. `cd` into the folder where you have cloned/downloaded the repository. You should be inside the folder with the `package.json` file.
12+
3. `npm install`
13+
4. `npm start`
14+
5. Open http://localhost:3000 in the browser of your choice.
15+
16+
To use another port (e.g. 4001), `npm start 4001`.
17+
18+
## Common Errors
19+
One common error at this point might be that the node app **doesn't have write access** to your git files. In this case, **open an elevated command prompt / terminal app** and try the above steps.

0 commit comments

Comments
 (0)