monk-minal

Monk-Minal

MonkeyType CLI: Power to the Typists

Explore the docs »

View Demo . Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

About The Project

MonkeyType Terminal is a powerful, open-source typing practice tool designed specifically for the command-line interface. It offers an immersive and interactive way to improve your typing speed and accuracy right from your terminal.

Inspired by the popular web-based tool MonkeyType, this project strives to bring that same functionality to the terminal environment. With a straightforward and user-friendly interface, users can practice their typing skills anytime, regardless of their internet connectivity.

Whether you're a developer seeking to boost your coding speed, a writer looking to enhance your typing accuracy, or simply a computer user who wants to improve your keyboard skills, MonkeyType Terminal is the ideal tool for you.

It provides a variety of features, such as adjustable word lengths, adjustable typing duration, a progress tracker, and customizable typing challenges. The tool also provides instant feedback on your performance, highlighting errors for quick recognition and learning.

Experience the thrill of improving your typing skills with MonkeyType Terminal, a typing tool that combines productivity and fun in the most engaging way possible.

Built With

This project utilizes a range of powerful packages to create an engaging and interactive command line interface experience:

• Boxen: For creating boxes in the terminal.
• Center-Align: For center-aligning text in the terminal.
• Chalk: For styling terminal string output with colors.
• CLI-Alerts: For creating informative alerts in the terminal.
• CLI-Cursor: For controlling the terminal cursor.
• CLI-Handle-Error: For better error handling in CLI.
• CLI-Handle-Unhandled: For catching unhandled errors and rejections.
• CLI-Meow-Help: For creating attractive help screens.
• CLI-Spinners: For displaying spinner animations in the terminal.
• CLI-Welcome: For displaying a welcome message.
• CLI-Width: For getting the terminal's width.
• Enquirer: For creating stylish command line prompts.
• Figlet: For creating ASCII Art from text.
• Meow: For parsing CLI input.
• Ora: For creating elegant terminal spinners.
• Random-Words: For generating random words.
• Readline: Built-in Node.js module for reading user input from the terminal.
• Readline-Sync: For synchronous user input from the terminal.
• Ruxe: For running external commands.
• Strip-Ansi: For removing ANSI escape codes from text.
• Word-Wrap: For wrapping text to a specified length.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/your_username_/Project-Name.git

2. Install NPM packages

npm install

3. Linking the package locally for testing

npm link

4. Enter mnm to start type

mnm

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (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

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• Shikhar Gupta - IT student - Shikhar Gupta - own's this repo and every line to the last semi-colon.

Acknowledgements

• Shikhar Gupta
• ImgShields