Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/linoxyn/worktimer

React Pomodoro Timer
https://github.com/linoxyn/worktimer

create-react-app javascript pomodoro-timer react styledcomponents

Last synced: 7 days ago
JSON representation

React Pomodoro Timer

Awesome Lists containing this project

README

        

# worktimer
A simple Create React App (CRA) Pomodoro timer. Can be saved as a stand alone app on your desktop.


[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

This project was started with [Create React App](https://github.com/facebookincubator/create-react-app).
You can find the most recent version of thier guide [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md).

[Styled Components](https://www.styled-components.com/docs) for styling the React components with CSS. Their documentation for use and tooling is excellent!

## My gh-page running example
[JHA Work Timer](https://linoxyn.github.io/worktimer/)

## Setting up
If you would like to checkout this repo. You will need [node](https://nodejs.org/en/) installed. You can use [yarn](https://yarnpkg.com/en/) instead of npm. Now start the process with the following:
```
> git clone https://github.com/linoxyn/worktimer.git
> cd worktimer
> npm install
> npm start
```

### Alternatively
Download the .zip file. Extract the contents, go to the project directory, start your terminal:
```
> npm install
> npm start
```

### Eslint and Prettier
You will need to set some rules up in your editor and also in your .eslintrc file to take advantage of automatically linting files on save.

A great guide to set this up in the [Visual Studio Code](https://code.visualstudio.com/) editor can be found on [Nicky's Blog](http://nickymeuleman.netlify.com/blog/automagically-lint/).

#### Enjoy!