Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 1.94 KB

README.md

File metadata and controls

68 lines (47 loc) · 1.94 KB
Raw

TypeTrek

TypeTrek is a comprehensive typing practice and improvement application designed to help users enhance their typing skills. With a focus on user engagement and detailed performance tracking, TypeTrek offers a range of features including interactive typing exercises, real-time feedback, and progress reporting.

Table of Contents

Features

  • User Authentication: Register and log in to save your progress.
  • Typing Exercises: Select from a variety of typing exercises designed to improve speed and accuracy.
  • Real-Time Feedback: Receive immediate feedback on your typing performance.
  • Progress Tracking: View your typing history and track improvements over time.
  • Report Generation: Generate detailed reports of your typing performance.

Installation

  1. Clone the repository: 
    git clone https://github.com/nyaxda/TypeTrek.git
cd typetrek
  2. Navigate to the TypeTrek directory:
	cd TypeTrek
  1. Install the required dependencies:
	pip install -r requirements.txt

Usage

To start using TypeTrek, follow these instructions:

  1. Run the application:
python run.py

  1. Open your web browser and navigate to http://localhost:5000.

  2. Register for an account or log in to start practicing your typing skills.

Contributing

Contributions to TypeTrek are welcome! Here's how you can contribute:

  1. Fork the repository.

  2. Create a new branch for your feature (git checkout -b feature/AmazingFeature).

  3. Commit your changes (git commit -m 'Add some AmazingFeature').

  4. Push to the branch (git push origin feature/AmazingFeature).

  5. Open a pull request.

Please make sure to add tests as appropriate.

License

TypeTrek is released under the ALX Africa License.