---

What's The Bookworm?

The Bookworm is a web application to practice spead reading.

The application uses React and is written in JavaScript.

Download

The Bookworm is a progressive web application. No download or installation is required. Browse to https://the-bookworm.web.app/ using a modern browser (the application was developed using Chrome).

You may also add the application to your home screen. (Check your browser documentation to find out how to install a progressive application.) This step is optional.

Have a bug or a feature request?

First, search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

Please read through the contributing guidelines which includes explanations about coding standards, and notes on development.

Developing

Development can be done on Mac, Windows, or Linux as long as you have NodeJS and Git.

This project was bootstrapped with Create React App.

Clone the project and run the command npm install.

Available Scripts

In the project directory, you can run:

Runs the app in the development mode.

$ npm start

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

Launches the test runner in the interactive watch mode.

$ npm test

See the section about running tests for more information.

Builds the app for production to the build folder.

$ npm run build

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

Deploying

The project's main branch is automatically deployed to Firebase using GitHub Actions (see .github/ directory)

Manual deployment

To deploy manually (not recommended):

$ firebase login
# Create a project from the console first https://console.firebase.google.com
$ firebase init
# Choose build/ instead of public/
$ npm run build
$ firebase deploy

Browse to: https://the-bookworm.web.app/