Skip to content
This repository was archived by the owner on Apr 2, 2026. It is now read-only.

README.md

Latest commit

 

History

History
39 lines (27 loc) · 1.86 KB

README.md

File metadata and controls

39 lines (27 loc) · 1.86 KB

Speadr

React TypeScript Tailwind CSS

Speadr is a minimalist web app aimed to significantly improve your reading skills by offering tools such as a speed reader.

Tech stack

This is a web app hosted on GitHub Pages built with React, TypeScript, and Tailwind, and the libraries Framer Motion, and React Icons. The src folder contains the frontend components and pages. The public folder contains frontend assets like icons and logos.

Quick start

To host Speadr on your machine for local development or other purposes, simply follow these steps below:

  1. Clone the GitHub repository using the command

    git clone https://github.com/tonymac129/speadr.git

  2. Open it with your favorite code editor or through the terminal

  3. Open the terminal and run the commands

    npm install
npm run dev

    to start the Vite dev server at localhost:5173/speadr and see the magic!

Contribution

Any kind of contribution is welcome, but please follow the guideline below!

  • Submit an issue if there's a bug/issue or if you want to suggest new features/subscriptions to be added.
  • Submit a pull request if you want to add or improve the code base!
  • Commit messages should be specific and address the issue
  • Please don't submit random issues that aren't specific
  • Please don't submit pull requests that "fix typo" or "improve formatting"