# 📦 NPM Practice CLI

[![Test All Platforms](https://github.com/MaxBlack-dev/npm-practice/actions/workflows/test-all-platforms.yml/badge.svg)](https://github.com/MaxBlack-dev/npm-practice/actions/workflows/test-all-platforms.yml)
[![Quick Test](https://github.com/MaxBlack-dev/npm-practice/actions/workflows/quick-test.yml/badge.svg)](https://github.com/MaxBlack-dev/npm-practice/actions/workflows/quick-test.yml)

This interactive CLI tutor is designed as hands-on practice for readers of
the [NPM Book by Max Black](https://www.amazon.com/dp/B0FSX9TZZ1). If you're working through the book, this tool will
guide you through real-world npm workflows — from initializing packages to installing dependencies — all from your
terminal.

---

## 🚀 Quick Start

## 📦 Prerequisites

To use this CLI tutor, you must have:

- **Node.js and npm installed** on your system. You can download them from the official site: [https://nodejs.org](https://nodejs.org)
- **npm version 11.6.2 or later** — all features in this tutor have been tested with npm 11.6.2.

### ✅ Linux / macOS

1. Open your terminal and navigate to the project folder.
2. Make file executable:

   ```bash
   chmod +x run-me.sh
   ```

3. Run the setup script:

   ```bash
   ./run-me.sh
   ```

4. Once setup is complete, start the CLI tutor:

   ```bash
   npm-practice
   ```

### ✅ Windows

1. Open the project folder in File Explorer.
2. Double-click run-me.cmd to run the setup.
3. Open Command Prompt and start the CLI tutor:
   ```bash
   npm-practice
   ```