relax-terminal

A mindful breathing exercise companion for developers that brings calmness right to your terminal. Take short, guided breathing breaks without leaving your development environment.

Relax Terminal 🧘‍♂️

A mindful breathing exercise companion for developers that brings calmness right to your terminal. Take short, guided breathing breaks without leaving your development environment.

✨ Features

  • 🎨 Beautiful ASCII art welcome message
  • 🌈 Color-coded breathing guidance
  • 💭 Randomized mindfulness quotes
  • ⏱️ 4-4-4 breathing technique (4s inhale, 4s hold, 4s exhale)
  • 📍 Centered, distraction-free display
  • 🔄 Continuous operation with smooth transitions

🚀 Installation

npm install -g relax-terminal

📚 Usage

Start your breathing session with:

relax-terminal

What to Expect

  1. Enter your name when prompted
  2. View your personalized ASCII art welcome message
  3. Follow the breathing cycle:
    • INHALE (Cyan) → 4 seconds
    • HOLD (Yellow) → 4 seconds
    • EXHALE (Magenta) → 4 seconds

To exit the application, press Ctrl + C

🧑‍💻 Technical Details

Dependencies

  • chalk - Terminal string styling
  • figlet - ASCII art text generation
  • center-align - Text centering utilities
  • readline - User input handling

Requirements

  • Node.js version 14.0.0 or higher
  • Terminal with color support

🤝 Contributing

  1. Fork the repository
  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

Next Steps to Boost Open Source Contributions:

1️⃣ Add Issues & Labels on GitHub – Create some beginner-friendly issues (good first issue, help wanted) to encourage contributions. 2️⃣ Improve Docs – Add screenshots or GIFs showing how the tool works. 3️⃣ Automate Releases – Set up a GitHub Action to auto-publish to npm on new commits. 4️⃣ Community Engagement – Share on dev forums like Dev.to, Hashnode, or Reddit. 5️⃣ Consider Future Features – Maybe customization options, more breathing exercises, or a fun ASCII animation?

📝 License