Skip to content

amitjimiwal/TypeSight

Repository files navigation

TypeSight

project-image

TypeSight the premier destination for typing speed and accuracy tests. Whether you’re a professional typist or just looking to improve your skills we’ve got you covered.

🧐 Features

Here're some of the project's best features:

  • Accurate Results
  • Increased Typing Accuracy
  • Detailed Reports
  • Real-time Eye Tracking

🚀 Demo Video

2024-05-15.21-26-33.mp4

🛠️ Installation Steps:

1. Clone the repository

git clone https://github.com/amitjimiwal/TypeSight

2. Since we are using submodules for integrating backend and the eyedetection you need to run the following command

git submodule init 

3. Update the submodules with the latest commit

git submodule update

4. Start backend server

cd sight-backend/

5. Go through env.sample file ,create a .env.local file and add all the corresponding environment variables in your local setup.

6. Start the application

npm install && npm run dev 

7. Setup the Eye Detection

cd EyeDirection/

8. Install the requirements.txt

pip install requirements.txt

9. Start the websocket server

python server.py

10. Start the Frontend

 cd ../

11. Go through env.sample file ,create a .env.local file and add all the corresponding environment variables in your local setup.

12. Start the application

npm install && npm run dev 

💻 Built with

Technologies used in the project:

  • React
  • Express
  • Mediapipe
  • OpenCV
  • Websockets
  • Typescript

🛡️ License:

This project is licensed under the The ReadLogs Project is licensed under the MIT License. Feel free to use modify and distribute the software as per the terms of the license.

💖Like my work?

Give a ⭐️ to this repository. Thank you for taking an interest! If you encounter any issues have suggestions or want to report a bug feel free to create an issue on the repository . Happy Coding!