Repository files navigation

Git Explorer provides offline-first support for previewing and comparing branches in a local git repository.

You can use the project locally on your system a couple different ways, depending on your preference. You will need to haveNodeJS LTS installed on your machine.

After running these commands, you can view the explorer web app in your browser atlocalhost:3000.

Usenpx to use the project (while online) for any local repository you have.

$cd /path/to/your/repo$ npx git-explorer

This approach will always use the latest version ofgit-explorer published to npm.

By installinggit-explorer globally, you can aceess the tool even if you're offline! Just use your preferred package manager's global installation command and then run the tool from the directory of your local repository.

# npm$ npm install -g git-explorer# or with Yarn$ yarn add --global git-explorer# now run git-explorer from your local repo$cd path/to/your/repo$ git-explorer

To upgrade your global install ofgit-explorer to a newer version, just re-run the global installation command again.

By default, Git Explorer runs on port3000. To run it on a different port, you can pass a custom--port flag. Example:

$ npx git-explorer --port 4200

To automatically open the default browser on start of the server, you can pass a custom--open flag. Example:

$ npx git-explorer --open

Contributions are welcome either in the form of code or ideas!

See something you want to have included in Git Explorer? Feel free toopen an issue, and if you're feeling ambitious, submit a PR!

To develop for the project, make sure you haveNodeJS andGit installed.

Then, you can do the following:

1. Clone the repo
2. Runnpm ci
3. Runnpm start

You should now be able to see the project running onlocalhost:3000

Note: If you make changes to src/server.js, make sure to restart the server by killing the server and re-runningnpm start