Skip to content

Commit 51830fc

Browse files
Updated document for v2.0.0
1 parent c7598a7 commit 51830fc

File tree

1 file changed

+35
-29
lines changed

1 file changed

+35
-29
lines changed

DOCUMENTATION.md

Lines changed: 35 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Introduction
2-
GitConvex is a web app for managing your git repositories. It is supported by Linux, Mac OS and Windows. The [latest version](https://github.com/neel1996/gitconvex-package/releases) of GitConvex supports git features such as initializing and tracking a git repo, staging and unstaging changes, committing changes, pushing changes to the selected remote and so on.
2+
GitConvex is a web app for managing your git repositories. It is supported by Linux, Mac OS and Windows. The [latest version](https://github.com/neel1996/gitconvex/releases) of GitConvex supports git features such as initializing and tracking a git repo, staging and unstaging changes, committing changes, pushing changes to the selected remote and so on.
33
The main goal of this platform is to act as a web-based alternative for Github desktop, but we are still in the starting stages, so we are not completely there yet (baby steps, right?)
44
## Table of Contents
55
[Requirements](#requirements)<br>
@@ -12,48 +12,54 @@ The main goal of this platform is to act as a web-based alternative for Github d
1212
- [Add a new branch](#add-new-branch)
1313

1414
## Requirements
15-
1. [Node JS](https://nodejs.org/en/) (Version 12.0+)
16-
2. [Git](https://git-scm.com/) (Version 2.20+)
15+
1. [Git](https://git-scm.com/) (Version 2.20+)
16+
17+
If you wish to build the application from source then install,
18+
- [Node JS](https://nodejs.org/en/) (Version 12.0+)
19+
- [go](https://golang.org/dl/)
20+
1721
## Download Options
1822
- **Option-1:** Directly clone the repo from GitHub
19-
`git clone https://github.com/neel1996/gitconvex-package`
23+
`git clone https://github.com/neel1996/gitconvex`
2024

21-
- **Option-2:** Downloading the zip file from the [releases](https://github.com/neel1996/gitconvex-package/releases).
25+
- **Option-2:** If you are into docker, then there is also a docker image available for gitconvex
26+
`docker pull itassistors/gitconvex`
2227

23-
- **Option-3:** GitConvex is also available on `npm`. Install the package globally to run it directly from the command line
24-
`npm i -g @itassistors/gitconvex`
28+
- **Option-3:** Downloading the zip file from the [releases](https://github.com/neel1996/gitconvex/releases).
2529

26-
This will install **GitConvex** as a global module and it can be started straight away from the command line with `gitconvex` command
2730
```
28-
$ gitconvex
29-
30-
INFO: Checking for config file
31-
INFO: Config file is present
32-
INFO: Reading from config file /usr/lib/node_modules/@itassistors/gitconvex/env_config.json
33-
GitConvex API connected!
34-
35-
Checking data file availability...
36-
INFO: Data file /usr/lib/node_modules/@itassistors/gitconvex/database/repo-datastore.json is present and it will be used as the active data file!
37-
You can change this under the settings menu
38-
GitConvex is running on port 9001
39-
Open http://localhost:9001/ to access GitConvex
31+
## Extract the downloaded zip file and execute the commands
32+
33+
$ cd gitconvex
34+
35+
# for Mac & Linux
36+
$ make build
37+
38+
# for Windows
39+
$ ./make.bat build
40+
4041
```
42+
4143
## Setup
44+
$ git clone https://github.com/neel1996/gitconvex.git
45+
<br>
46+
$ cd gitconvex
47+
48+
# For Mac & Linux
49+
$ make build
4250

43-
If either download **Option-1** or **Option-2** is opted, then the following steps need to be followed to setup GitConvex
44-
1. For installing all dependencies,
45-
`` $npm install ``
51+
# For Windows
52+
$ ./make.bat build
4653

47-
2. To start the server, either use normal node command
48-
`` $node server.js ``
49-
or use `pm2` by downloading it from npm - `npm i -g pm2` and start the module by executing the following command,
50-
`pm2 start ecosystem.config.js`
54+
## After build completion...
55+
$ ./dist/gitconvex-server
5156

5257
## Features available
5358
- Visualizing basic repo stats such as active branch, active remotes, number of files tracked etc
5459
- Tracking modified files
5560
- Creating new branches (provided there are no diverging changes)
5661
- Initializing git inside a new repo and adding it to the platform tracker on the go
62+
- Secure clone option with authentication
5763
- File difference tracker with syntax highlighting
5864
- File explorer with repository navigation features
5965
- Code view capability from in-build repository explorer
@@ -75,7 +81,7 @@ or use `pm2` by downloading it from npm - `npm i -g pm2` and start the module by
7581
![add-a-repo](https://user-images.githubusercontent.com/65342122/88536126-db9d2680-d028-11ea-890f-c5fc11cd7cf0.png)
7682

7783
- Enter repo name and paste the repo path. If the folder is not a git repo then check the "*Check this if the folder is not a git repo*" checkbox to initialize git.
78-
![repo-details](https://user-images.githubusercontent.com/65342122/88486721-70f2d900-cf9d-11ea-802d-00b0b2aaf638.png)
84+
![repo-details](https://user-images.githubusercontent.com/65342122/101984594-80eb2b00-3ca8-11eb-97e5-5804ddfaed61.png)
7985

8086
- The newly added repo will be displayed as a card in the dashboard
8187
![repo-card](https://user-images.githubusercontent.com/65342122/89167157-ab113b80-d598-11ea-8985-2469e7ad261e.png)
@@ -169,4 +175,4 @@ In "Git Difference" click on the modified file to see the difference. The platfo
169175
## Help and Support
170176

171177
- Visit help section if you're facing an issue or need any help. If you have any queries or feedback, then discuss it in "Discord" or report an issue in GitHub.
172-
![help-and-support](https://user-images.githubusercontent.com/65342122/94940199-d2c94500-04f0-11eb-9212-16c57d642c61.png)
178+
![help-and-support](https://user-images.githubusercontent.com/65342122/101984821-d96ef800-3ca9-11eb-913e-f1cc062fae56.png)

0 commit comments

Comments
 (0)