Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/builtwithluv/ZenFocus
ZenFocus for Windows and macOS
https://github.com/builtwithluv/ZenFocus
Last synced: 3 days ago
JSON representation
ZenFocus for Windows and macOS
- Host: GitHub
- URL: https://github.com/builtwithluv/ZenFocus
- Owner: builtwithluv
- License: mit
- Created: 2017-05-15T23:58:11.000Z (over 7 years ago)
- Default Branch: next
- Last Pushed: 2018-09-20T05:49:12.000Z (about 6 years ago)
- Last Synced: 2024-08-02T13:29:44.012Z (3 months ago)
- Language: JavaScript
- Homepage: https://zenfocus.surge.sh
- Size: 4.36 MB
- Stars: 99
- Watchers: 9
- Forks: 24
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZenFocus
ZenFocus at its core is based off the time management technique known as the Pomodoro technique developed by Francesco Cirillo. In short, it is a way for individuals to plan, focus and complete tasks in the form of managing different time blocks (focus time, short breaks and long breaks). This technique is used by many in different industries including but not limited to education, medical, fitness and music.
## Install
First, [fork the repo](https://github.com/builtwithluv/ZenFocus) and clone to your local.
And then install dependencies.
**ProTip**: Install with [yarn](https://github.com/yarnpkg/yarn) for faster and safer installation:
```bash
$ cd your-project-name && yarn install
```
## Run
Start the app in the `dev` environment. This starts the renderer process in [**hot-module-replacement**](https://webpack.js.org/guides/hmr-react/) mode and starts a server sends hot updates to the renderer process:
```bash
$ yarn run dev
```
## DevTools
#### Toggle Chrome DevTools
- OS X: Cmd Alt I or F12
- Linux: Ctrl Shift I or F12
- Windows: Ctrl Shift I or F12
*See [electron-debug](https://github.com/sindresorhus/electron-debug) for more information.*
#### DevTools extension
This boilerplate is included following DevTools extensions:
* [Devtron](https://github.com/electron/devtron) - Install via [electron-debug](https://github.com/sindresorhus/electron-debug).
* [React Developer Tools](https://github.com/facebook/react-devtools) - Install via [electron-devtools-installer](https://github.com/GPMDP/electron-devtools-installer).
* [Redux DevTools](https://github.com/zalmoxisus/redux-devtools-extension) - Install via [electron-devtools-installer](https://github.com/GPMDP/electron-devtools-installer).
You can find the tabs on Chrome DevTools.
If you want to update extensions version, please set `UPGRADE_EXTENSIONS` env, just run:
```bash
$ UPGRADE_EXTENSIONS=1 yarn run dev
# For Windows
$ set UPGRADE_EXTENSIONS=1 && yarn run dev
```
:bulb: You can debug your production build with devtools by simply setting the `DEBUG_PROD` env variable:
```
DEBUG_PROD=true yarn run package
```
## Test
```bash
yarn test
```
Note: If you receive this error:
```bash
TypeError: Path must be a string. Received undefined
at assertPath (path.js:28:11)
at Object.join (path.js:1239:7)
at Object. (app/node_modules/electron-settings/lib/settings.js:47:31)
at Object. (app/node_modules/electron-settings/index.js:10:18)
```
then assign default variable to string like so
```
const settingsFilePath = path.join(userDataPath || '', settingsFileName || '');
```
## Maintainers
- [Cheng Sieu Ly](https://github.com/chengsieuly)
- [Edward Guo](https://github.com/ehguo)
- [Hoon Choi](https://github.com/hoonchoi)
- [Thon Ly](https://github.com/thonly)
## License
MIT © [builtwithluv](https://github.com/builtwithluv)