https://github.com/iagodahlem/tiempo
:clock1: Pomodoro app for the modern web.
https://github.com/iagodahlem/tiempo
architecture awilix dependency-injection ducks ducks-pattern enzyme javascript jest nodejs pomodoro pomodoro-timer react react-dom redux redux-thunk styled-components tdd tiempo timer yarn
Last synced: 3 months ago
JSON representation
:clock1: Pomodoro app for the modern web.
- Host: GitHub
- URL: https://github.com/iagodahlem/tiempo
- Owner: iagodahlem
- License: mit
- Created: 2017-12-17T18:46:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-15T19:26:48.000Z (over 2 years ago)
- Last Synced: 2024-04-09T14:49:12.016Z (about 1 year ago)
- Topics: architecture, awilix, dependency-injection, ducks, ducks-pattern, enzyme, javascript, jest, nodejs, pomodoro, pomodoro-timer, react, react-dom, redux, redux-thunk, styled-components, tdd, tiempo, timer, yarn
- Language: JavaScript
- Homepage: https://tiempo.iagodahlem.com
- Size: 8.6 MB
- Stars: 9
- Watchers: 3
- Forks: 4
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# tiempo
[](https://travis-ci.org/iagodahlem/tiempo)
[](https://codecov.io/gh/iagodahlem/tiempo)
[](https://cypress.io)
Pomodoro app for the modern web. Click [here to access it live](https://tiempo.iagodahlem.com/).
Clock takes you through a full pomodoro cycle of three 25 minute work sessions with 5 minute breaks in between and a 15 minute long break at the end.
## Requirements
- Node v11.6.0
- Yarn v1.12.3
## Install
Installing **Yarn**
If npm package manager is already installed, you can use
```
npm install --global yarn
```
to install and update Yarn.
Otherwise, if homebrew is installed, you can use
```
brew install yarn
```
and
```
brew update yarn
```
to update your current version.
Other installation instructions specific to your machine for yarn can be found [here](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable).
You can then use
```
yarn --version
```
to ensure it is installed and check which version you have.
To download the latest version of **Node**, click [here](https://nodejs.org/en/download/).
## Running
You can run this command
```
git clone https://github.com/iagodahlem/tiempo.git
```
to clone the repository on your local machine and run the start command to spin up the development server.
To start the development server, you can run the command
```
yarn start
```
To run all the test suite.
```sh
yarn test
```
## Understanding the codebase
Under the [src/pomodoro/app](src/pomodoro/app) folder exists the different functionalities of the timer including play, pause, skip, and stop.
Under the [src/pomodoro/containers](src/pomodoro/containers) folder exists the controls for keyboard and mouse input as well as the header, footer, and other sections of the app.
The [cypress folder](cypress) contains tests and supporting documents for tests.
This code is written using the Redux library and documentation and support can be found [on the official Redux support page](https://redux.js.org).
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## License
[MIT License](http://iagodahlem.mit-license.org/) © Iago Dahlem