Use any of the below options to get gitconvex for your system
- Option - 1 Cloning repo from github
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.
$ git clone https://github.com/neel1996/gitconvex.git
$ cd gitconvex
# for Mac & Linux
$ make build
# for Windows
$ ./make.bat build
## After build completion...
$ ./dist/gitconvex-server
2020/11/14 22:57:47 INFO: Starting Gitconvex server modules
2020/11/14 22:57:47 INFO: Using available env config file
2020/11/14 22:57:47 INFO: Gitconvex started on http://localhost:9001
- Option - 2 If you are into docker, then there is also a docker image available for gitconvex
docker pull itassistors/gitconvex
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
- Option - 3 Downloading the zip file from the tagged github release
## Extract the downloaded zip file and execute the commands
$ cd gitconvex
# for Mac & Linux
$ make build
# for Windows
$ ./make.bat build
| supported platforms |
|---|
| Linux 🐧 |
| Mac OS 🍎 |
| Windows 🔲 |
| Software | Purpose |
|---|---|
| Git | Required for handling some intense git operations with the target repo |
| Go | For building the backend from the source |
| Node JS | For building the react UI bundle from scratch |
Important note for windows users
If you are a windows user, then make sure that git is accessible from the command line without using git bash.
- Open command prompt or powershell and enter
git --versionand press enter. If it displays the following output, then it is fine
C:\> git --version
git version 2.28.0.windows.1
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,
C:\> git --version
'git' is not recognized as an internal or external command,
operable program or batch file.
This can be fixed by adding git to the PATH environment variable in windows. The process of setting this up is available here
Refer the detailed Documentation for how to setup and use the platform
This is the final production build for gitconvex and direct contributions will not be accepted to this repo. If you wish to contribute to this project, then it has to be made to the following repos which are dedicated to the frontend (React) and backend (Go) for the platform
- Frontend repo - Build with React JS
- Backend repo - Build with GoLang
Please make sure that you are following the contribution guidelines for the respective repos.
For reporting issues or for requesting any feature use the following medium,
See LICENSE info for more
