GitHub Issue
A desktop application created with ElectronJS and ReactJS to be cross-platform to manage and track GitHub issues.
Built With
- ReactJS - ReactJS
- ElectronJS - ElectronJS
- 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 debugging guide
Install
First, clone the repo via git:
git clone --depth=1 https://github.com/mariorodeghiero/git-issue-react-electronjs.git your-project-name
And then install dependencies with yarn.
$ cd your-project-name
$ yarn
Note: If you can't use yarn, run npm install
.
Run
Start the app in the dev
environment:
$ yarn dev
OR
$ npm run dev
Packaging
You can debug your production build with devtools by simply setting the DEBUG_PROD env variable:
$ DEBUG_PROD=true yarn package
To package apps for the local platform:
$ npm run package
To package apps for all platforms:
First, refer to Multi Platform Build for dependencies.
Then,
$ npm run package-all
To package apps with options:
$ 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 for details on our code of conduct, and the process for submitting pull requests to us.
Author
Contributors
License
This project is licensed under the MIT License - see the LICENSE.md file for details