https://github.com/keziahmoselle/tempus

⏳ A simple yet featureful pomodoro in the tray/menubar
https://github.com/keziahmoselle/tempus

electron hacktoberfest linux macos macosx menubar pause pomodoro productivity react tempus timer tray windows windows-10

Last synced: 8 days ago
JSON representation

⏳ A simple yet featureful pomodoro in the tray/menubar

• Host: GitHub
• URL: https://github.com/keziahmoselle/tempus
• Owner: KeziahMoselle
• License: mit
• Created: 2018-12-30T22:39:59.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-10-01T15:25:25.000Z (about 4 years ago)
• Last Synced: 2024-08-05T08:09:34.978Z (3 months ago)
• Topics: electron, hacktoberfest, linux, macos, macosx, menubar, pause, pomodoro, productivity, react, tempus, timer, tray, windows, windows-10
• Language: JavaScript
• Homepage: https://tempus.keziahmoselle.fr/
• Size: 35.4 MB
• Stars: 123
• Watchers: 8
• Forks: 14
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  





  Tempus





  A simple yet featureful pomodoro in the tray/menubar





  

    

  

    

  

    

  

  

  

    

  

   

    

  

  

  

    

  

  





  





  Download 



## Features

Click on the arrows to get more informations about these features

	⏱️ Change work time and pause time

  
Want to work 27 min ? You can.

	


    

  


	⏲️ Automagically set the timer till the next hour

  
Want to work until 8 PM ? You can set the timer automagically for you.

  
Note: It will revert your settings after the timer.

  

	


    

  


	🚩 Goals

  
Want to work at least 1 hour a day ? You can create a goal for that.

	


    

  


	🔥 Streak

  
It counts how many times you finished a pomodoro.

	


    

  


	📊 Statistics

  
It gives you insights about your productivity.

	


    

  


	🔁 Cycles

  
If set, it will automatically stop the pomodoro after `x` times.

	


    

  


## Want to contribute ?

### Prerequisites

* Have [Node.js](https://nodejs.org/en/)  installed (> 8)

* Have [Yarn](https://yarnpkg.com/en/) installed (> 1.4.2)

### Steps

1. Clone the repository

```sh

$ git clone https://github.com/KeziahMoselle/tempus.git

```

2. Create a new branch (i.e: feat-new-feature)

3. Install dependencies :

```sh

$ cd tempus && yarn

```

4. Run the app

In a browser :

```sh

$ yarn web

```

In Electron :

```sh

$ yarn electron

```

### Build

To build the app (without Electron) you will need to run :

The `/build` directory is in `packages/app/build`

```sh

$ yarn build:app

```

To build the app with Electron you will need to run :

The `/build` directory is in `packages/electron/dist`

```sh

$ yarn build:electron

```

### Tests

Run tests for the application only :

```sh

$ yarn test:app

```

Run tests for the Electron app :

```sh

$ yarn test:electron

```

See [Test Cases (need to implement)](./TESTCASES.md)

### Project tree

```

|-- packages

    |-- app		The React app

    |   |-- build	The build of the React app

    |   |-- public	.html and assets go here

    |   |-- src		React components and assets for the components

    |-- core		Modules being shared between the browser and Node

    |-- electron

        |-- assets	Assets like tray icons

        |-- dist	The build of the electron app

        |-- tests	Tests

        |-- utils	Utility functions

```

## Built With

* [Electron](https://electronjs.org/) - framework for creating native applications with web technologies

* [React](https://reactjs.org) - A JavaScript library for building user interfaces

## Contributors

Thank you ❤️













## License

This project is licensed under the [MIT License](LICENSE).