Skip to content

neel1996/gitconvex

Gitconvex

Web application for managing your git repositories

Build Status

Gitconvex UI pipeline Gitconvex Server pipeline

Download options

Use any of the below options to get gitconvex for your system

github release gitconvex-choco docker image

Windows

Gitconvex is available on chocolatey. Install chocolatey and run the following command to install gitconvex

> choco install gitconvex

If you do not prefer chocolatey then the binaries for windows can be downloaded from the releases

Linux

Download the tarball for Linux from releases. Extract the tar and run the following script to install the required dependencies

> ./lib/linux_x86_64/install_deps

After setting up the dependency libs, just run gitconvex from the terminal to start gitconvex

Gitconvex is also available as a homebrew tap which can be easily installed using the following command (provided brew is already installed on the linux machine)

> brew install itassistors/taps/gitconvex

MacOS

Gitconvex is readily available as a Homebrew Tap on github. Run the following command to download & install gitconvex on the go

> brew install itassistors/taps/gitconvex

Docker

If you are into docker, then there is 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 it is not required

Build from source

Libgit2 is required for building gitconvex from source. The LIBGIT_NOTES file includes all the guidelines to download and setup libgit for different platforms

To be Noted: The master branch contains the latest and the 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

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

Platforms

supported platforms
Linux 🐧
Mac OS 🍎
Windows πŸ”²

Requirements

Software Purpose
Git For cloning gitconvex and to build the application from scratch
Go For building the backend from the source
Node JS For building the React UI bundle from scratch

Detailed documentation

Refer the detailed Documentation for how to setup and use the platform

Contributions

Contributions are always welcome for the project. Please do refer the Contribution Guidelines for details

Help and Feedback

For reporting issues or for requesting a new feature, use the following channels

Discord Channel

Website

Github Issue Reporting

open issues

License

License