jaroslawzielinski/my-yellow-duck

My Yellow Duck Project

1.0.13 2024-03-12 07:59 UTC

CC0-1.0

• Jarosław Zieliński

README

Welcome to My Yellow Duck project! 🦆🌼

Have you ever found yourself in need of someone to talk to about a problem or bug you're facing while coding? Introducing My Yellow Duck, your trusty companion for rubber duck debugging sessions!

Simply type anything you'd like to ask or discuss, just like you would on Slack, Rocket.Chat, or any other messaging platform. When you're ready to copy your message and share it with someone, the Duck will ask you, "Are you sure?" It's your chance to validate your thoughts and make sure you're ready to take the next step.

But beware! The mysterious "Yellow Duck Effect" may take hold before you even copy your message. Who knows what insights and solutions might come to you while interacting with your duck companion? Embrace the unexpected!

And guess what? You can even attach a shortcut to My Yellow Duck on your system toolbar for quick access! 🚀

How to Install

To get started with My Yellow Duck, follow these simple steps:

in packagist

1. Clone the repository:

git clone https://github.com/JaroslawZielinski/my-yellow-duck.git

1. Navigate to the project directory:

cd my-yellow-duck

1. Copy .env.dist to .env (you may edit .env configuration file):

cp .env.dist .env

1. Install the dependencies:

npm install

1. Launch My Yellow Duck:

npm start

That's it! Your Yellow Duck is ready to assist you in your coding adventures. Happy rubber duck debugging!

It may be useful for Ubuntu users:

• You may add this application to system toolbar in Ubuntu (using alacarte f.e) with duck icon .

• If you would like to open window only once ignoring multiple clicking, you may create running script like this:

#!/bin/bash

if pgrep "electron" >/dev/null; then
    echo ""
else
    cd ~/my-yellow-duck && npm install && npm start
fi

See Also

To learn more about the concept of rubber duck debugging, check out the following link:

Rubber duck debugging