Kudos

👏 Kudos is a versatile and interactive web application, meticulously crafted to revolutionize the way you appreciate and celebrate your colleagues in the workplace. Kudos allows you not only to send tailor-made "Kudo" cards, but also to enhance them with your personal touch.

Transform your workplace culture by celebrating individual and team accomplishments, fostering positive reinforcement, and promoting an atmosphere of genuine appreciation with Kudos!

🌟 Features

📝 Personalized Text: Add heartfelt messages to let your colleagues know how much they mean to you.

🎴 Multiple Templates: Choose from a variety of templates to suit the occasion.

🎨 Drawing Functionality: Unleash your creativity by drawing directly on the card for that extra personal touch.

💾 Download Cards: Save individual Kudo cards as high-quality PNG images to share outside the application or keep as mementos.

🎉 Presentation Mode: Planning to showcase the Kudos in a team meeting or special occasion? Switch to Presentation Mode, where you can shuffle through all received cards and celebrate together as a team.

🗂 Archiving: Keep track of all the positive vibes by utilizing our archiving functionality. Save cherished moments and revisit them any time you need a morale boost.

Developing

To get you up and running you need to run the following steps:

1. Install nvm and install the required NodeJS version with nvm install
2. Make sure you run the correct NodeJS version with nvm use
3. Install dependencies with npm install
4. Copy .env.example to .env and configure database connection: DATABASE_URL="postgres://kudos:secret@localhost:5432/kudos"
5. Start database with docker compose up -d
6. Run database migrations with npm run db:migrate
7. Start local dev server with npm run dev

The application will be available at http://localhost:5173

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

Environment Variables

The following environment variables can be configured:

• DATABASE_URL: PostgreSQL connection string (required)
• ORIGIN: The origin URL for the application (required for production)
• KUDOS_MIGRATE: Set to "1" or "true" to run database migrations on startup (optional)

Example:

DATABASE_URL="postgresql://kudos:secret@localhost:5432/kudos"
ORIGIN="https://your-domain.com"
KUDOS_MIGRATE="1"

Deployment

Docker

The application can be deployed using the provided Docker image:

docker run -e DATABASE_URL="your-db-url" -e ORIGIN="your-origin" -p 3000:3000 ghcr.io/synyx/kudos:main

Docker Compose

For a complete setup including the database, you can use Docker Compose. This will start both the PostgreSQL database and the Kudos application:

# Start the application and database
docker compose up -d

# View logs
docker compose logs -f

# Stop the services
docker compose down

The application will be available at http://localhost:3000. The Docker Compose configuration automatically handles database migrations through the KUDOS_MIGRATE environment variable.

Helm Chart

A Helm chart is available for Kubernetes deployment. The chart uses an init container to handle database migrations automatically, so the KUDOS_MIGRATE environment variable is not needed in the main application container.

For Helm deployment, the migration process is handled separately from the main application container, ensuring reliable database setup before the application starts.

Install via Helm

# add repo
helm repo add synyx https://synyx.github.io/kudos/docs/helm
helm repo update

# inspect defaults
helm show values synyx/kudos > values.yaml
# edit as needed

# install or upgrade
helm upgrade --install kudos synyx/kudos \
  --version <CHART VERSION> \
  -f values.yaml