https://github.com/teewrath/cli-letter
A cli letter for your siginificant one
https://github.com/teewrath/cli-letter
Last synced: over 1 year ago
JSON representation
A cli letter for your siginificant one
- Host: GitHub
- URL: https://github.com/teewrath/cli-letter
- Owner: TeeWrath
- Created: 2024-02-26T13:56:49.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-26T18:16:29.000Z (over 2 years ago)
- Last Synced: 2025-02-09T12:31:44.867Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 3.45 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ❤️ Command Line Letter ❤️
### 💌 Ask them if they will be your Valentine? 💌
*Built with ❤️ using JavaScript*
---
## 🚀 How to Use This Project
Follow these simple steps to create your personalized Valentine CLI:
### 💌 1. Personalize the Letter
Open `index.js` and add your name:
```javascript
const rainbowTitle = chalkAnimation.rainbow(`This is a letter from (Your Name)\n`);
```
Replace `(Your Name)` with your name (Line 16 in `index.js`).
### 📦 2. Publish Your NPM Package
Publish your changes as a package:
```bash
npm login
npm version patch
npm publish
```
### 💻 3. Share the Love ❤️
Ask them to run your CLI using:
```bash
npx
```
---
## 💞 Try the Existing Package
Want to see it in action? Try the existing version:
```bash
npx cli-letter
```
---
## 🛠️ Packages Used
- [chalk](https://github.com/chalk/chalk) - Terminal string styling
- [inquirer](https://github.com/SBoudrias/Inquirer.js) - Interactive prompts
- [gradient-string](https://github.com/bokub/gradient-string) - Beautiful gradients
- [chalk-animation](https://github.com/bokub/chalk-animation) - Terminal animations
- [figlet](https://github.com/patorjk/figlet.js) - ASCII text generator
- [nanospinner](https://github.com/usmanyunusov/nanospinner) - Lightweight spinner
### 📦 Install All Dependencies:
```bash
npm i chalk chalk-animation figlet gradient-string inquirer nanospinner
```
---
## 🌟 Show Some Love
If this project helped you get your Valentine, don't forget to ⭐ the repository!
💖 Happy Valentine’s Day! 💖