Pomo 🍅

Simple Pomodoro timer

Also turning off all electron safety settings so use at own risk.

Usage

🚧 Currently in Beta

MacOS only right now

To use the app, head to the Releases and grab the .dmg file (assets is a dropdown, see screenshot below, the version number may change, but you get the idea).

There are many small features to add and these are tracked on the Roadmap

Please raise any bugs or request any features here.

Slack Integration

If you want to use the slack settings, you can go to the settings in the Pomo app, (the button at the top left takes you there), and then you’ll see a form to add the relevant credentials:

• a slack token: go to https://my.slack.com/customize, open your browser devTools and copy what you get from typing TS.boot_data.api_token
• a 'd' cookie: to get the cookies, you can go to slack in the browser (like any normal chat window, not the customise page) and grab the d and d-s cookies
• a 'd-s' cookie: as above.

Contributing

Pomo is not yet ready for contribution, but once V1 is released, all contributions will be welcome, and the approach to making changes will be very clear

Pomo is an electron app built using:

• Typescript throughout (with very strict settings)
• React for the GUI
• Storybook for building components and User documentation
• Backstop.js for visual regression tests
• Spectron for e2e tests running against the production electron app (it's a wrapper around webdriver.io which in turn wraps selenium)
• Github actions for CI (not yet supporting publishing)

Install a node manager of your choice (volta is supported and recommended)

Install Dependencies

yarn install

Run the electron app and client locally

yarn dev

Run storybook for developing UI components

yarn storybook

Some other useful commands

command	description
yarn clean	[aggresive] remove all files not recognised by git, then install all dependencies
yarn lint	use eslint to check source code in the repo for errors
yarn test	use ts-jest to run the project's unit tests. This will also compile via typescript to check for type errors as part of ts-jest
yarn visual	use backstop.js to run visual regression tests against a running storybook (yarn storybook). Does not yet run on CI, so please run locally before opening Pull Requests.
yarn e2e	run spectron tests located in the e2e folder. run yarn build before running
yarn build	build the project for production and e2e testing (no the same as the release script)
yarn checks	runs the full checklist of lint, test, build and e2e
yarn docker-e2e	runs the e2e tests via a Dockerfile in a headless state - this is how CI will run these tests
yarn release	see releasing wiki for information

License

MIT