Running the Project

Running the project relies on npm being installed and functional. To complete this step visit the node wiki page.

Commands should be run from the root directory of VisualGit.

Setting up the project dependencies (npm install)

Before the program can be run, the npm install command is required to make sure all dependencies of the project are installed on your machine. It is important to note that whenever there are changes to the dependencies (i.e. the package-lock.json file is modified) you will have to run the npm install command again to make sure your project is up to date. Failure to do so may result in unintended behaviour when running the project.

Running the project (npm start)

VisualGit can be launched with the npm start command. The full command is npm-run-all -p createjs electron:serve This command both compiles the typescript files to javascript files to ensure any changes made to the typescript files are updated in the javascript files and also starts the electron application.

While the project is running

The project uses file watching such that any change to typescript files while the program is running will cause a "refresh" i.e. the program will recompile and restart.