https://github.com/meebuhs/typey-boi

Practice typing by reading a book.
https://github.com/meebuhs/typey-boi

electron eslint parcel prettier react redux styled-components stylelint typescript

Last synced: 4 days ago
JSON representation

Practice typing by reading a book.

• Host: GitHub
• URL: https://github.com/meebuhs/typey-boi
• Owner: Meebuhs
• License: mit
• Created: 2020-07-16T02:25:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T12:20:45.000Z (almost 2 years ago)
• Last Synced: 2023-03-04T10:19:48.835Z (over 1 year ago)
• Topics: electron, eslint, parcel, prettier, react, redux, styled-components, stylelint, typescript
• Language: TypeScript
• Homepage:
• Size: 2.04 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Typey Boi



  



Practice typing by reading a book.

Built with:

- Typescript

- React

- Redux

- Styled-components

- Parcel

- Electron

Style-checking:

- Prettier

- Eslint

- Stylelint

## Usage

## Download

Download typey-boi.exe from the [latest release](https://github.com/Meebuhs/typey-boi/releases)

Text is then loaded from a text file; [Calibre](https://calibre-ebook.com/) can be used to convert your ebooks to .txt.

It's a good idea to delete all the front matter from the start of the text file, typing out a table of contents isn't the most interesting thing in the world.

## Development

```

git clone https://github.com/Meebuhs/typey-boi

cd typey-boi

yarn

```

### Yarn commands

| Command         | Description                                     |

| --------------- | ----------------------------------------------- |

| `yarn build`    | Packages a production build of this extension.  |

| `yarn dev`      | Starts a local development server on port 1234. |

| `yarn lint`     | Runs eslint and stylelint.                      |

| `yarn prettier` | Perform in-place prettier reformat.             |

| `yarn precommit`| Runs lint and prettier.                         |

| `yarn dist`     | Compresses the current build for distribution.  |

| `yarn electron` | Starts electron.                                |

| `yarn dist`     | Packages a distribution build using electron.   |

## License

This project is released as open source under the [MIT License](https://opensource.org/licenses/MIT)