Table of Contents

• About The Project
  • Description
  • Built With
• Getting Started
• Acknowledgments

About The Project

Built with

• 
• 
• 
• 
• 
• 
• 
• 

Description

• Custom made smooth typing input that displays live errors.
• Different typing modes, such as 'time', 'words', 'quote'.
• Multiplayer 1v1 mode to play against your friends.
• Fetches Random quotes using 'quotable' API.
• Results after typing is done, including WPM, Accuracy, Errors, Interactive Dashboard.
• User can customize the app to their liking.
• Various app color themes.
• User can create account that will be saved on database.
• Personal stats, history and customizations will be saved to the account.

Getting Started

1. Clone the repository, and move to the root directory of the project

git clone https://github.com/LukaKobaidze/typing-app

2. Add required environment variables to server

   Create .env file in server directory

  MONGODB_CONNECTION=<your-mongodb-connection-string>
  JWT_SECRET=<your-jwt-secret>

3. Install NPM packages (handles both client & server packages)

npm run install-all

4. Run the app locally

npm run dev

Acknowledgments

• random-words
• quotable API
• Inspired by monkeytype