@itassistors/gitconvex v1.1.6

Gitconvex

Web application for managing your git repositories

Download options

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-package.git
$ cd gitconvex-package
$ npm start

• Option - 2 Downloading package from npm

npm i -g @itassistors/gitconvex

This will install gitconvex as a global module and it can be started straight away from the command line with gitconvex command

$ gitconvex

INFO: Checking for config file
INFO: Config file is present
INFO: Reading from config file /usr/lib/node_modules/@itassistors/gitconvex/env_config.json
GitConvex API connected!

Checking data file availability...
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!

You can change this under the settings menu

Gitconvex is running on port 9001

    Open http://localhost:9001/ to access gitconvex

• Option - 3 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 - 4 Downloading the zip file from the tagged github release

## Extract the downloaded zip file and execute the commands

$ cd gitconvex-package
$ npm start

Platforms

Requirements

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 --version and 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

Detailed documentation

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

License

See LICENSE info for more