{"id":15664864,"url":"https://github.com/thescientist13/git-explorer","last_synced_at":"2025-05-05T23:53:57.018Z","repository":{"id":36930801,"uuid":"224343530","full_name":"thescientist13/git-explorer","owner":"thescientist13","description":"Offline-first support for previewing and comparing branches in a local git repository.","archived":false,"fork":false,"pushed_at":"2023-01-27T01:54:45.000Z","size":462,"stargazers_count":16,"open_issues_count":9,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-23T16:34:15.993Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thescientist13.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-27T04:23:05.000Z","updated_at":"2024-06-28T11:25:50.000Z","dependencies_parsed_at":"2023-02-15T04:01:21.025Z","dependency_job_id":null,"html_url":"https://github.com/thescientist13/git-explorer","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thescientist13%2Fgit-explorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thescientist13%2Fgit-explorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thescientist13%2Fgit-explorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thescientist13%2Fgit-explorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thescientist13","download_url":"https://codeload.github.com/thescientist13/git-explorer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252350500,"owners_count":21734028,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T13:44:22.669Z","updated_at":"2025-05-05T23:53:57.002Z","avatar_url":"https://github.com/thescientist13.png","language":"JavaScript","readme":"# git-explorer\n![GitHub Actions status](https://github.com/thescientist13/git-explorer/workflows/Master%20Integration/badge.svg)\n[![GitHub release](https://img.shields.io/github/tag/thescientist13/git-explorer.svg)](https://github.com/thescientist13/git-explorer/tags)\n[![license](https://img.shields.io/github/license/thescientist13/git-explorer.svg?style=flat-square)](https://github.com/thescientist13/git-explorer)\n\n\n## Overview\nGit Explorer provides offline-first support for previewing and comparing branches in a local git repository.\n![git-explorer](./git-explorer.png)\n\n\n## Usage\nYou can use the project locally on your system a couple different ways, depending on your preference.  You will need to have [NodeJS](https://nodejs.org/) LTS installed on your machine.\n\n\u003e _After running these commands, you can view the explorer web app in your browser at `localhost:3000`_.\n\n### One Time (npx)\nUse `npx` to use the project (while online) for any local repository you have.\n```shell\n$ cd /path/to/your/repo\n$ npx git-explorer\n```\n\n\u003e This approach will always use the latest version of **git-explorer** published to npm.\n\n### Offline (global npm / Yarn)\nBy installing **git-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.\n```shell\n# npm\n$ npm install -g git-explorer\n\n# or with Yarn\n$ yarn add --global git-explorer\n\n# now run git-explorer from your local repo\n$ cd path/to/your/repo\n$ git-explorer\n```\n\n\u003e To upgrade your global install of **git-explorer** to a newer version, just re-run the global installation command again.\n\n### Options\n\n#### Port\n\nBy default, Git Explorer runs on port `3000`. To run it on a different port, you can pass a custom `--port` flag.  Example:\n```shell\n$ npx git-explorer --port 4200\n```\n\n#### Open\n\n To automatically open the default browser on start of the server, you can pass a custom `--open` flag. Example:\n```shell\n$ npx git-explorer --open\n```\n\n## Contributing\nContributions are welcome either in the form of code or ideas!\n\n### Ideas / Feature Requests\nSee something you want to have included in Git Explorer?  Feel free to [open an issue](https://github.com/thescientist13/git-explorer/issues), and if you're feeling ambitious, submit a PR!\n\n### Development\nTo develop for the project, make sure you have [NodeJS](https://nodejs.org/) and [Git](https://git-scm.com/) installed.\n\nThen, you can do the following:\n1. Clone the repo\n1. Run `npm ci`\n1. Run `npm start`\n\nYou should now be able to see the project running on `localhost:3000`\n\n\u003e _**Note**: If you make changes to src/server.js, make sure to restart the server by killing the server and re-running `npm start`_\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthescientist13%2Fgit-explorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthescientist13%2Fgit-explorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthescientist13%2Fgit-explorer/lists"}