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

https://github.com/remarkablemark/speedreader

👀 Speed reading app
https://github.com/remarkablemark/speedreader

app javascript react site speed-reader speed-reading tailwindcss typescript vite website

Last synced: about 2 months ago
JSON representation

👀 Speed reading app

Awesome Lists containing this project

README

          

# Speed Reader

[![build](https://github.com/remarkablemark/speedreader/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablemark/speedreader/actions/workflows/build.yml)
[![test](https://github.com/remarkablemark/speedreader/actions/workflows/test.yml/badge.svg)](https://github.com/remarkablemark/speedreader/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/remarkablemark/speedreader/graph/badge.svg?token=TRsPJGWN5E)](https://codecov.io/gh/remarkablemark/speedreader)

👀 Speed speeding app:

- [Speed Reader](https://remarkablemark.org/speedreader/)

## Install

Clone the repository:

```sh
git clone https://github.com/remarkablemark/speedreader.git
cd speedreader
```

Install the dependencies:

```sh
npm install
```

## Run

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.

Open [http://127.0.0.1:5173](http://127.0.0.1:5173) to view it in the browser.

The page will reload if you make edits.

You will also see any errors in the console.

### `npm run build`

Builds the app for production to the `dist` folder.

It correctly bundles in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

### `npm run lint`

Checks code quality.

### `npm run lint:tsc`

Checks for type errors.

### `npm test`

Runs tests.

## License

[MIT](LICENSE)