https://github.com/weedz/git-good
Just a simple git client using electron and nodegit, focus on lightweight and performance
https://github.com/weedz/git-good
electron git nodegit typescript
Last synced: about 1 month ago
JSON representation
Just a simple git client using electron and nodegit, focus on lightweight and performance
- Host: GitHub
- URL: https://github.com/weedz/git-good
- Owner: weedz
- License: gpl-3.0
- Created: 2020-04-17T20:52:59.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2026-02-12T23:38:16.000Z (about 1 month ago)
- Last Synced: 2026-02-13T08:32:59.635Z (about 1 month ago)
- Topics: electron, git, nodegit, typescript
- Language: TypeScript
- Homepage:
- Size: 2.82 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# git-good
Just a simple git client using electron and nodegit, focus on lightweight and performance
Build for linux:
```bash
pnpm install
# make sure nodegit dependencies are installed and build nodegit against node
# pnpm does not clone with submodules so need to re-clone the nodegit repo
rm -rf node_modules/nodegit && \
mkdir node_modules/nodegit && \
pushd node_modules/nodegit && { \
git clone --recurse-submodules https://github.com/weedz/nodegit . && \
# `--ignore-scripts` to prevent something (node-gyp ?) from automatically building
pnpm install --ignore-scripts && \
JOBS=max pnpm run rebuild \
}; popd;
# build nodegit for electron, and "compile" typescript files
make
pnpm start
```
## Build from source
Follow instructions from .
### Linux
```bash
make
```
### Arch Linux
PKGBUILD is available from .
### Ubuntu/debian
To successfully build/link nodegit on linux you will need the following packages:
```plain
build-essential
libssh-dev
libkrb5-dev
```
### Windows
Install (C and C++ package manager for windows),
needed for openssl dependency. Then install the `openssl` package with:
```bash
> vcpgk install openssl
```
#### vcpkg
Follow instructions here, .
1. Clone to something like `C:\dev\vcpkg`. And run the "bootstrap" script.
2. On windows we need `openssl@1.1.1`. In order to install this with `vcpkg`
we need a `vcpkg.json` file. Create the following file in `C:\dev`:
```json
{
"dependencies": ["openssl"],
"builtin-baseline": "2ac61f87f69f0484b8044f95ab274038fbaf7bdd",
"overrides": [
{
"name": "openssl",
"version-string": "1.1.1n"
}
]
}
```
(What is `builtin-baseline`, )
And run `.\vcpkg\vcpkg.exe install` in `C:\dev`.
3. Make sure to use correct Visual Studio version, .
Does not build with msvs2022. Need msvs2019: `npm config set msvs_version 2019`
4. Seems like the "postinstall" script for `nodegit` will fail on windows.
But the `electron-rebuild` script will succeed.
## Start
Install node modules:
```bash
pnpm install
```
Then run
```bash
pnpm run build
```
to bundle javascript-files and move assets to the `dist/` directory.