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
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 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?)
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.
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?)
-**Option-2** Downloading the zip file from the [releases](https://github.com/neel1996/gitconvex-package/releases).
21
+
-**Option-2:** Downloading the zip file from the [releases](https://github.com/neel1996/gitconvex-package/releases).
12
22
13
-
-**Option-3** GitConvex is also available on `npm`. Install the package globally to run it directly from the command line
23
+
-**Option-3:** GitConvex is also available on `npm`. Install the package globally to run it directly from the command line
14
24
`npm i -g @itassistors/gitconvex`
15
25
16
-
This will install **gitconvex** as a global module and it can be started straight away from the command line with `gitconvex` command
26
+
This will install **GitConvex** as a global module and it can be started straight away from the command line with `gitconvex` command
17
27
```
18
28
$ gitconvex
19
29
@@ -25,8 +35,8 @@ GitConvex API connected!
25
35
Checking data file availability...
26
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!
27
37
You can change this under the settings menu
28
-
Gitconvex is running on port 9001
29
-
Open http://localhost:9001/ to access gitconvex
38
+
GitConvex is running on port 9001
39
+
Open http://localhost:9001/ to access GitConvex
30
40
```
31
41
## Setup
32
42
@@ -44,27 +54,27 @@ or use `pm2` by downloading it from npm - `npm i -g pm2` and start the module by
44
54
- Tracking modified files
45
55
- Creating new branches (provided there are no diverging changes)
46
56
- Initializing git inside a new repo and adding it to the platform tracker on the go
47
-
- File difference tracker with syntax highlighting for the [supported languages](LANGUAGES.md).
57
+
- File difference tracker with syntax highlighting for the [supported languages](LANGUAGES.md).
48
58
- Commit log viewer
49
59
- Basic git operations such as staging, un-staging, committing and pushing to remote repo.
50
60
51
61
## How to use
52
62
53
63
### Left Pane Menu
54
64
55
-
-**Repositories** - To check tracked files changes, linebased changes with syntax highlighting and git operations (staging, unstaging, commiting changes and pushing changed to remote)
56
-
-**Settings** - To check and edit internal data file, to remove a repo from gitconvex and to update the active port.
65
+
-**Repositories** - To check tracked files changes, line-based changes with syntax highlighting and git operations (staging, un-staging, committing changes and pushing changed to remote)
66
+
-**Settings** - To check and edit internal data file, to remove a repo from GitConvex and to update the active port.
57
67
-**Help** - Includes documentation link and various options to report an issue or to submit feedback.
58
68
59
69
### Adding a new repo
60
70
- Use "+" at the bottom right corner to add a repo.
- 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.
- Git operations module consists of three basic git operations( Stage all changes, commit changes, push to remote). Below this file status is display and the files can be staged with add action or click on "stage all changes" to stage all the files from the chosen repo.
- 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 comitted 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
- 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
In "Git Difference" click on the modified file(s) to see the difference. The platform has syntax highlighting available for a limited set of [languages](LANGUAGES.md)
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
128
138
- In the saved repos section, added repo(s) can be deleted permanently from GitConvex.
129
139
130
-
>Note that, this will only remove the repo from gitconvex records andit will not perform an actual folder delete operation
140
+
>Note that, this will only remove the repo from GitConvex records and it will not perform an actual folder delete operation
131
141
132
142
- The port number can be updated to an available alternate port. Make sure that the port is not in use. The app needs to be restarted for the port change to take effect.
133
143
134
-
## Help
144
+
## Help and Support
135
145
136
146
- 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