Skip to content

D-Seonay/mindful-metrics

Repository files navigation

Mindful Metrics

A simple web application to test and track your reflexes and typing speed. This project is built with Vite, React, TypeScript, and shadcn/ui.

Project Vision

Mindful Metrics aims to provide an intuitive and engaging platform for users to enhance their cognitive performance through interactive tests and detailed progress tracking. Our goal is to empower users to understand and improve their reaction times, typing speed, and overall mental agility.

Features

  • Reflex Test: Test your reaction time. The application will calculate the average of 5 tests.
  • Typing Test: Test your typing speed. You can choose between different modes:
    • Time: Test for a specific duration (15s, 30s, 60s, 120s).
    • Words: Type a specific number of words (10, 25, 50, 100).
  • Performance Tracking: A dedicated page to view your history, statistics, and progress for both the reflex and typing tests.
  • Language Selection: The typing test supports both English and French.
  • Color Sensitivity Test: Test your ability to differentiate subtle color nuances with various difficulty levels.
  • Light/Dark Mode: The application supports both light and dark themes.
  • Data Export: You can save your entire performance history as a JSON file.

Contributing

We welcome contributions! If you're interested in improving Mindful Metrics, please feel free to fork the repository and submit pull requests. Ensure your code adheres to the existing style and conventions, and includes appropriate tests.

Getting Started

Prerequisites

Installation

  1. Clone the repository:
    git clone https://github.com/D-Seonay/mindful-metrics.git
  2. Navigate to the project directory:
    cd mindful-metrics
  3. Install the dependencies:
    npm install

Running the Application

To start the development server, run:

npm run dev

The application will be available at http://localhost:5173.

Technologies Used

About

A simple web application to test and track your reflexes, typing speed and more. This project is built with Vite, React, TypeScript, and shadcn/ui.

Topics

Resources

Stars

Watchers

Forks

Contributors