Skip to content

Commit 3559048

Browse files
authored
update documentation for v2.0.0
Updated documentation with new feature list and guidelines for gitconvex v2.0.0
2 parents e252ea2 + 3032b1e commit 3559048

File tree

1 file changed

+24
-32
lines changed

1 file changed

+24
-32
lines changed

DOCUMENTATION.md

Lines changed: 24 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,51 @@
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>
66
[Download Options](#download-options)<br>
7-
[Setup](#setup)<br>
87
[Features available](#features-available)<br>
98
[How to use](#how-to-use)
109
- [Adding a new repo](#adding-a-new-repo)
1110
- [Repo Details](#repo-details)
1211
- [Add a new branch](#add-new-branch)
1312

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

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

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`
27+
- **Option-3:** Downloading the zip file from the [releases](https://github.com/neel1996/gitconvex/releases).
2528

26-
This will install **GitConvex** as a global module and it can be started straight away from the command line with `gitconvex` command
27-
```
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
4029
```
41-
## Setup
30+
## Extract the downloaded zip file and execute the commands
4231
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 ``
32+
$ cd gitconvex
4633
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`
34+
# for Mac & Linux
35+
$ make build
36+
$ ./dist/gitconvex
37+
38+
# for Windows
39+
$ ./make.bat build
40+
$ ./dist/gitconvex.exe
41+
```
5142

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

7769
- 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)
70+
![repo-details](https://user-images.githubusercontent.com/65342122/101985829-556c3e80-3cb0-11eb-8449-ed9a05621c8e.png)
7971

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

171163
- 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)
164+
![help-and-support](https://user-images.githubusercontent.com/65342122/101987492-5efaa400-3cba-11eb-87fb-6d8cb19ae9d2.png)

0 commit comments

Comments
 (0)