Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mariorodeghiero/git-commands
💻 GIT Commands is a desktop app built with ElectronJS and ReactJS to be cross-platform, providing quick access to the main Git commands and with direct links to the documentation.
https://github.com/mariorodeghiero/git-commands
cross-platform electron electron-app electronjs es6 es6-javascript eslint git github javascript react react-components react-router reactjs yarn
Last synced: 3 months ago
JSON representation
💻 GIT Commands is a desktop app built with ElectronJS and ReactJS to be cross-platform, providing quick access to the main Git commands and with direct links to the documentation.
- Host: GitHub
- URL: https://github.com/mariorodeghiero/git-commands
- Owner: mariorodeghiero
- License: mit
- Created: 2018-07-20T00:18:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-18T01:58:32.000Z (about 6 years ago)
- Last Synced: 2024-02-29T18:33:24.602Z (10 months ago)
- Topics: cross-platform, electron, electron-app, electronjs, es6, es6-javascript, eslint, git, github, javascript, react, react-components, react-router, reactjs, yarn
- Language: JavaScript
- Homepage:
- Size: 131 MB
- Stars: 36
- Watchers: 5
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/mariorodeghiero/git-commands/tags)
[](http://opensource.org/licenses/MIT)
# Git Commands
Git Commands is a desktop app built with ElectronJS and ReactJS to be cross-platform, providing quick access to the main Git commands and with direct links to the documentation.
## Screenshot
**Note!!** You can download the App for **Mac** and **Windows** in [Git Commands](https://mariorodeghiero.com/git-commands/).
## Built With
* [ReactJS](https://reactjs.org) - ReactJS
* [ElectronJS](https://electronjs.org) - ElectronJS
* [electron-react-boilerplate](https://github.com/chentsulin/electron-react-boilerplate) - electron-react-boilerplate
## Prerequisites
* **Requires a node version >= 7 and an npm version >= 4.**
* **If you have installation or compilation issues with this project, please see [our debugging guide](https://github.com/mariorodeghiero/git-commands/issues/2)**
## Install
First, clone the repo via git:
```bash
git clone --depth=1 https://github.com/mariorodeghiero/git-commands.git your-project-name
```
And then install dependencies with yarn.
```bash
$ cd your-project-name
$ yarn
```
**Note**: If you can't use [yarn](https://github.com/yarnpkg/yarn), run `npm install`.
## Run
Start the app in the `dev` environment:
```bash
$ npm run dev
```
## Packaging
To package apps for the local platform:
```bash
$ npm run package
```
To package apps for all platforms:
First, refer to [Multi Platform Build](https://www.electron.build/multi-platform-build) for dependencies.
Then,
```bash
$ npm run package-all
```
To package apps with options:
```bash
$ npm run package -- --[option]
```
To improve the usability of this App, you can create keyboard shortcuts to start quickly.
* For Mac_OS use "Automator".
* For Windows access "Properties" of the App.
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Author
* [Mário Antônio do Amaral Rodeghiero](https://github.com/mariorodeghiero)
## Contributors
| [](https://github.com/mariorodeghiero) |
| --------------------------------------------------------------------------------------------------------------------- |
| [Mário Rodeghiero](https://github.com/mariorodeghiero)
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details