diff --git a/client/desktop/README.md b/client/desktop/README.md index 40e5114a..c44487ab 100644 --- a/client/desktop/README.md +++ b/client/desktop/README.md @@ -1,153 +1,19 @@ - +## Usage -
- -

- Electron React Boilerplate uses Electron, React, React Router, Webpack and React Fast Refresh. -

- -
- -
- -[![Build Status][github-actions-status]][github-actions-url] -[![Github Tag][github-tag-image]][github-tag-url] -[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/Fjy3vfgy5q) - -[![OpenCollective](https://opencollective.com/electron-react-boilerplate-594/backers/badge.svg)](#backers) -[![OpenCollective](https://opencollective.com/electron-react-boilerplate-594/sponsors/badge.svg)](#sponsors) -[![StackOverflow][stackoverflow-img]][stackoverflow-url] - -
- -## Install - -Clone the repo and install dependencies: +### Install dependency ```bash -git clone --depth 1 --branch main https://github.com/electron-react-boilerplate/electron-react-boilerplate.git your-project-name -cd your-project-name -npm install +yarn ``` -**Having issues installing? See our [debugging guide](https://github.com/electron-react-boilerplate/electron-react-boilerplate/issues/400)** - -## Starting Development - -Start the app in the `dev` environment: +### dev ```bash -npm start +yarn dev ``` -## Packaging for Production - -To package apps for the local platform: +### package ```bash -npm run package +yarn package ``` - -## Docs - -See our [docs and guides here](https://electron-react-boilerplate.js.org/docs/installation) - -## Community - -Join our Discord: https://discord.gg/Fjy3vfgy5q - -## Donations - -**Donations will ensure the following:** - -- 🔨 Long term maintenance of the project -- 🛣 Progress on the [roadmap](https://electron-react-boilerplate.js.org/docs/roadmap) -- 🐛 Quick responses to bug reports and help requests - -## Backers - -Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/electron-react-boilerplate-594#backer)] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -## Sponsors - -Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/electron-react-boilerplate-594-594#sponsor)] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -## Maintainers - -- [Amila Welihinda](https://github.com/amilajack) -- [John Tran](https://github.com/jooohhn) -- [C. T. Lin](https://github.com/chentsulin) -- [Jhen-Jie Hong](https://github.com/jhen0409) - -## License - -MIT © [Electron React Boilerplate](https://github.com/electron-react-boilerplate) - -[github-actions-status]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/workflows/Test/badge.svg -[github-actions-url]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/actions -[github-tag-image]: https://img.shields.io/github/tag/electron-react-boilerplate/electron-react-boilerplate.svg?label=version -[github-tag-url]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/releases/latest -[stackoverflow-img]: https://img.shields.io/badge/stackoverflow-electron_react_boilerplate-blue.svg -[stackoverflow-url]: https://stackoverflow.com/questions/tagged/electron-react-boilerplate