https://github.com/ranitmanik/do-you-know-ranit

JavaScript CLI-based game that helps you get to know me better.
https://github.com/ranitmanik/do-you-know-ranit

cli-app cli-game javascript node nodejs npm npm-package npmjs terminal-app terminal-game

Last synced: 4 months ago
JSON representation

JavaScript CLI-based game that helps you get to know me better.

Host: GitHub
URL: https://github.com/ranitmanik/do-you-know-ranit
Owner: RanitManik
License: mit
Created: 2024-06-17T14:08:35.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-06-24T05:36:55.000Z (about 2 years ago)
Last Synced: 2025-02-15T08:34:58.354Z (over 1 year ago)
Topics: cli-app, cli-game, javascript, node, nodejs, npm, npm-package, npmjs, terminal-app, terminal-game
Language: JavaScript
Homepage: https://npmjs.com/package/do-you-know-ranit
Size: 70.3 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md

Awesome Lists containing this project

README

# Do You Know Ranit?

A fun and interactive CLI quiz game to test your knowledge about Ranit Manik. This game challenges players with
questions about Ranit's background, skills, and social media presence.

**Get all the questions right, or face the consequences!**

Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Global Installation](#global-installation)
- [Using npx](#using-npx)
- [How to Play](#how-to-play)
- [Example](#example)
- [Development](#development)
- [Dependencies](#dependencies)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgement](#acknowledgement)

## Features

- Animated rainbow title using `chalk-animation`
- Beautiful console messages with `chalk`
- Smooth gradient text with `gradient-string`
- Interactive questions using `inquirer`
- Engaging spinner animations with `nanospinner`
- ASCII art congratulations with `figlet`

## Installation

### Global Installation

To install and run the game globally, use:

```sh
npm install -g do-you-know-ranit
do-you-know-ranit
```

### Using npx

To run the game without installing globally, use `npx`:

```sh
npx do-you-know-ranit
```

## How to Play

1. The game will start with a welcome message and instructions.
2. You will be asked to enter your name.
3. Answer each question correctly to proceed to the next one.
4. If you answer any question incorrectly, the game will end.
5. Answer all questions correctly to win the game.

## Example

```sh
$ do-you-know-ranit
```

Upon running the above command, you will see the animated title followed by a series of questions. Here's a sample
interaction:

```
Do You Know RANIT?

HOW TO PLAY
I am a process on your computer.
If you get any question wrong I will be killed
So get all the questions right...

What is your name? (Player)

Where is Ranit currently pursuing his higher education?
1) College of Engineering & Management, Kolaghat
2) IIT Kharagpur
3) NIT Durgapur
4) Jadavpur University

Nice work [Player]. That's a legit answer
...
Congrats , [Player] !
You know Ranit well!
```

https://github.com/RanitManik/do-you-know-ranit/assets/138437760/258b00fb-f50e-4cad-913d-ed37b368af10

## Development

To run the game locally without installing globally:

1. Clone the repository:

```sh
git clone https://github.com/RanitManik/do-you-know-ranit.git
```

2. Navigate to the project directory and install dependencies:

```sh
cd do-you-know-ranit
npm install
```

3. Run the game:

```sh
node index.js
```

## Dependencies

- [chalk](https://www.npmjs.com/package/chalk): Terminal string styling.
- [inquirer](https://www.npmjs.com/package/inquirer): Interactive command line prompts.
- [gradient-string](https://www.npmjs.com/package/gradient-string): Beautiful gradient strings.
- [chalk-animation](https://www.npmjs.com/package/chalk-animation): Animations for the terminal.
- [figlet](https://www.npmjs.com/package/figlet): Create ASCII art from text.
- [nanospinner](https://www.npmjs.com/package/nanospinner): Minimal and elegant terminal spinners.

## Contributing

Feel free to submit issues or pull requests. For major changes, please open an issue first to discuss what you would
like to change.

## License

This project is licensed under the **[MIT License](LICENSE)**.

## Contact

Social Media
Username
Link

Email
ranitmanik.dev@gmail.com
Email

LinkedIn
Ranit Manik
LinkedIn

Instagram
ranit_manik_
Instagram

Facebook
RanitKumarManik
Facebook