Skip to content

A real-time donation tracker with a dynamic jar visualization. Tracks progress toward a donation goal, updates in real-time, and changes color every 10% of the goal reached. Built with Node.js, Express, and Socket.IO.

Notifications You must be signed in to change notification settings

StratosMylonas/donation-jar-tipeeestream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Donation Jar

A real-time donation tracker that displays total donations visually in a jar. Built with Node.js, Express, and Socket.IO.

Features

  • Real-time donation updates using WebSocket.
  • Dynamic and animated donation jar visualization.
  • Configurable donation goals and initial values via .env file.

Installation

  1. Clone the repository:
git clone https://github.com/StratosMylonas/donation-jar-tipeeestream.git
cd donation-jar
  1. Install dependencies:
npm install
  1. Create a .env file in the root directory and configure
PORT=3000
TIPEEESTREAM_API_KEY=<your-api-key>
GOAL_TITLE="Your Goal Title"
INITIAL_GOAL=0
TOTAL_GOAL=1000
  1. Start the server:
npm start
  1. Open your browser and navigate to (or add a new Browser Source to OBS pointing to):
http://localhost:3000

Environment Variables

  • PORT: The port on which the server runs (default: 3000).
  • TIPEEESTREAM_API_KEY: API key for TipeeeStream WebSocket integration.
  • GOAL_TITLE: Title of the donation goal.
  • INITIAL_GOAL: Initial donation amount.
  • TOTAL_GOAL: Target donation amount.

Dependencies

  • Express: Web server framework.
  • Socket.IO: Real-time WebSocket communication.
  • Axios: HTTP client for API requests.
  • dotenv: Environment variable management.

How It Works

  1. The server connects to the TipeeeStream WebSocket API to listen for donation events.
  2. When a new donation is received, the server updates the total donation amount and broadcasts the update to all connected clients.
  3. The client-side script dynamically updates the donation jar visualization.

Screenshots

Screenshot 2025-04-03 105740 Screenshot 2025-04-03 105905 Screenshot 2025-04-03 105958

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

A real-time donation tracker with a dynamic jar visualization. Tracks progress toward a donation goal, updates in real-time, and changes color every 10% of the goal reached. Built with Node.js, Express, and Socket.IO.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published