The Bookworm is a web application to practice spead reading.
The application uses React and is written in JavaScript.
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.
First, search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.
Please read through the contributing guidelines which includes explanations about coding standards, and notes on development.
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:
$ npm startOpen http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
$ npm testSee the section about running tests for more information.
$ npm run buildIt correctly bundles React in production mode and optimizes the build for the best performance.
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 deployBrowse to: https://the-bookworm.web.app/