https://github.com/kelvinqiu802/landscape

A Pomodoro Timer with Video Background
https://github.com/kelvinqiu802/landscape

background clock landscape nature pomodoro-timer timer video white-noise

Last synced: 30 days ago
JSON representation

A Pomodoro Timer with Video Background

• Host: GitHub
• URL: https://github.com/kelvinqiu802/landscape
• Owner: KelvinQiu802
• License: mit
• Created: 2024-01-18T09:57:01.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-10T05:38:29.000Z (over 1 year ago)
• Last Synced: 2024-11-15T08:19:09.073Z (11 months ago)
• Topics: background, clock, landscape, nature, pomodoro-timer, timer, video, white-noise
• Language: TypeScript
• Homepage: https://landscape-pomodoro.vercel.app
• Size: 5.13 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          







  

    

  


Landscape Pomodoro


  


	Pomodoro Timer with Dynamic Video Background

    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  





  

    

  

  

    

  

  

    

  

  

    

  



## About The Project

![Landscape Screen Shot](./images/screenshot.png)

Landscape Pomodoro is like having your own Pomodoro Timer, complete with beautiful background videos and calming sounds. Use it as your second screen to enhance your work efficiency in a relaxed and enjoyable manner.

## Getting Started

This is an example of how you may give instructions on setting up your project locally.

To get a local copy up and running follow these simple example steps.

### Installation

1. Clone the repo

   ```sh

   git clone https://github.com/kelvinqiu802/landscape.git

   cd landscape

   ```

2. Install NPM packages

   ```sh

   npm install

   ```

3. Build the project

   ```sh

   npm run build

   ```

4. Start the project

   ```sh

   npm run start

   ```

## Knowing Issues

- The **video quality** will enhance in a few seconds.

  - YouTube will automatically adjust the video quality based on your internet connection speed.

## Contributing

1. Expand the library of background videos in [youtube.json](./src/data/youtube.json).

2. Provide translations in various languages.

3. Address and resolve any identified bugs.

4. Introduce new features to enhance the overall functionality.

## License

Distributed under the `MIT` License. See `LICENSE` for more information.

## Contact

KelvinQiu - kelvinqiu802@outlook.com