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
Copy file name to clipboardExpand all lines: DOCUMENTATION.md
+17-18Lines changed: 17 additions & 18 deletions
Display the source diff
Display the rich diff
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.
0 commit comments