About ttyping

• ttyping is a terminal-based typing practice tool written in Python, utilizing the curses module.
• It offers a range of typing sessions suitable for users at various skill levels, spanning from beginner to advanced.
• Each lesson within the tool comes with a specific goal measured in words per minute (WPM).

Some Snapshots:

Home screen

Lesson screen

Practice Screen

Result Screen

How to Run This Project

These instructions will guide you through the process of running this project on your system. Follow these steps carefully to ensure a successful execution.

Via Cloning

Prerequisites

Before you begin, make sure you have the following prerequisites installed on your system:

• Python3 (version 3.10 or higher)
• Virtual Environment (venv)

Installation

1. Clone the Project Repository:

   Clone this project repository to your local machine using Git. Open your terminal or command prompt and navigate to the directory where you want to store the project:

   git clone https://github.com/gouravsaini021/ttyping

2. Create and Activate a Virtual Environment:

   cd ttyping
   python -m venv venv

   Activate the virtual environment: on windows: .\venv\Scripts\activate on linux or macOS: source venv/bin/activate

3. Install Project Dependencies:

   pip install -r requirements.txt 

4. Run the Python Script:

   python3 main.py

Using Docker

Prerequisites:

Before you begin, make sure you have the Docker installed on your system:

Installation:

Run the following command: docker run -it gouravsaini/ttyping:2.0

Download Pyinstaller Executables

1. Navigate to the Executable Folder:

   Open your project directory, and you will see a folder named Executable.

2. Choose Your Operating System Folder:

   Inside the Executable folder, you will find subfolders named after various operating systems, such as Windows, macOS, or Linux. Select the folder that corresponds to your operating system.

3. Locate the Executable:

   Within your chosen operating system folder, you will find an executable file named ttyping and download it to your system.

4. Run the Executable: Go to the folder where the executable is downloaded via Terminal and run ./ttyping