You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# New Features
- Branch searching feature for filtering required branches (#85)
- Option to update repo name from settings (#78)
# Improvements and Bug Fixes
- Branch checkout bug (#120)
- Branch list with invalid branch name when repo has no HEAD (#121)
- Few minor UI polishes here and there
- Updated axios version to resolve CVE-2020-28168
Copy file name to clipboardExpand all lines: DOCUMENTATION.md
+17-18
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
# Introduction
2
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.
3
-
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?)
3
+
The main goal of this platform is to act as a web-based alternative for native git GUI clients and also to provide an option for managing git repos which are residing in servers with no GUI. Gitconvex is also available as a docker image along with the yaml files included in the repo for deploying it with k8s or docker swarm, which makes it a viable option for managing git repos residing within containers.
4
4
## Table of Contents
5
5
[Requirements](#requirements)<br>
6
6
[Download Options](#download-options)<br>
7
7
[Features available](#features-available)<br>
8
8
[How to use](#how-to-use)
9
9
-[Adding a new repo](#adding-a-new-repo)
10
10
-[Repo Details](#repo-details)
11
-
-[Add a new branch](#add-new-branch)
11
+
-[List all branches](#list-all-branches)
12
12
13
13
## Requirements
14
14
1.[Git](https://git-scm.com/) (Version 2.20+)
@@ -92,17 +92,17 @@ The repo detail view also provides features for performing the following operati
92
92
- Code view for valid files from the file explorer view
- Git operations module lets you handle three basic git operations (**Stage all changes, commit changes, push to remote**). Below this option, the files will be displayed and the files can be staged individually using the "Add" button or as a whole using the "stage all changes".
- The staged changes can be committed using the **Commit changes** option. This will display a pop-up with all the staged files and it requires a commit message to successfully commit the changes. The commit messages can either be a single line message or a multi-line message
-**Push to remote** option pushes all commits to the selected remote host. The pop-up displayed will display the commits which are in queue to be pushed to the remote repository
-**Push to remote** option pushes all commits to the selected remote host. The pop-up displayed will display the commits which are in queue to be pushed to the remote repository.
129
127
130
-
This section will let you know if the selected remote is not valid or if the push operation fails
In "Git Difference" click on the modified file to see the difference. The platform has syntax highlighting available for a limited set of [languages](LANGUAGES.md)
- Server data file stores repo details such as the repo path, timestamp and the unique ID assigned to each repo. The data file must be an accessible JSON file with read / write permissions set to it. Also make sure you enter the full path for the file. E.g: /opt/my_data/data-file.json
155
152
- In the saved repos section, added repo(s) can be deleted permanently from GitConvex.
153
+
- Saved repo name can be changed in this section.
156
154
157
155
>Note that, this will only remove the repo from GitConvex records and it will not perform an actual folder delete operation
158
156
@@ -161,4 +159,5 @@ In "Git Difference" click on the modified file to see the difference. The platfo
161
159
## Help and Support
162
160
163
161
- 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.
15
16
16
17
# Download options
17
18
18
19
> Use any of the below options to get gitconvex for your system
**To be Noted :** The `master` branch contains the latest stable build of the project. For a reliable experience, always clone the repo from the master branch.
2020/11/14 22:57:47 INFO: Starting Gitconvex server modules
46
44
2020/11/14 22:57:47 INFO: Using available env config file
@@ -50,37 +48,38 @@ $ ./dist/gitconvex-server
50
48
51
49
-**Option - 2** If you are into **docker**, then there is also a docker image available for gitconvex
52
50
53
-
`docker pull itassistors/gitconvex`
51
+
```shell
52
+
docker pull itassistors/gitconvex
53
+
```
54
54
55
55
**Note:** Make sure you mount the host volume to the container to access the git repos from the host system. If you have git repos stored within your containers, then this is not required
56
56
57
57
-**Option - 3** Downloading the zip file from the tagged github [**release**](https://github.com/neel1996/gitconvex/releases)
58
58
59
-
```
59
+
```shell
60
60
## Extract the downloaded zip file and execute the commands
61
-
62
-
$ cd gitconvex
61
+
cd gitconvex
63
62
64
63
# for Mac & Linux
65
-
$ make build
64
+
make build
66
65
67
66
# for Windows
68
-
$ ./make.bat build
67
+
./make.bat build
69
68
70
69
```
71
70
72
71
# Platforms
73
72
74
73
|supported platforms|
75
-
|--|
74
+
|---|
76
75
|Linux :penguin:|
77
76
|Mac OS :apple:|
78
77
|Windows :black_square_button:|
79
78
80
79
## Requirements
81
80
82
81
| Software | Purpose |
83
-
| -- | -- |
82
+
| ---|--- |
84
83
| <b>[Git](https://git-scm.com/)</b> | <b>Required for handling some intense git operations with the target repo</b> |
85
84
| <b>[Go](https://golang.org/)</b> | <b>For building the backend from the source</b> |
86
85
| <b>[Node JS](https://nodejs.org/en/)</b> | <b>For building the react UI bundle from scratch</b> |
@@ -91,15 +90,15 @@ If you are a windows user, then make sure that `git` is accessible from the comm
91
90
92
91
- Open command prompt or powershell and enter `git --version` and press enter. If it displays the following output, then it is fine
93
92
94
-
```
93
+
```cmd
95
94
C:\> git --version
96
95
97
96
git version 2.28.0.windows.1
98
97
```
99
98
100
99
If this output is not displayed and if the command throws the following error, then it shows that `git` is not added to the 'path' environment variable and it will not be accessible directly from the command line,
101
100
102
-
```
101
+
```cmd
103
102
C:\> git --version
104
103
105
104
'git' is not recognized as an internal or external command,
@@ -140,9 +139,14 @@ For reporting issues or for requesting any feature use the following medium,
0 commit comments