Skip to content

StatStream is a web analytics tracking project designed to monitor and store website statistics using Discord for reporting.

License

Notifications You must be signed in to change notification settings

KeptCodes/StatStream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

81 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

StatStream Website Analytics Tool

Docker Node.js

⭐ About

StatStream is a web analytics tracking project designed to monitor and store website statistics using Discord for reporting. The goal of this project is to track essential website data, such as traffic and user interactions, and send that data to a Discord channel using a custom bot.

Features

  • Website Analytics: Track website activity like page views, user interactions, and more.
  • Discord Integration: Use a custom Discord bot to report website statistics in real-time.
  • Customizable: Easily extend the analytics and reporting functionality to fit your needs.

Requirements

Installation

Step 1: Setting up the Discord Bot

  1. Go to the Discord Developer Portal.
  2. Create a new bot.
  3. Get the bot token.
  4. Invite the bot to your server.

Step 2: Set up the Project

Clone the repository to your local machine:

git clone https://github.com/yourusername/statstream.git
cd statstream

Install the required dependencies:

For the Node.js bot:

cd statsteam
bun install

Step 3: Configure the Bot

In the discord-bot folder, create a .env file with the following content:

DISCORD_TOKEN=your-discord-bot-token
APP_ID=your-bot-app-id
DISCORD_GUILD_ID=your-discord-server-id

Step 4: Running the Bot

Once your bot is configured, run the bot using:

node main.js

Usage

Once everything is set up, your Discord bot will begin reporting the tracked website statistics in real-time. You can extend the functionality by adding more events and analytics to track.

Contributing

Contributions are welcome! Please open an issue or submit a pull request with any improvements or bug fixes.

  1. Fork the repository
  2. Create a new branch (git checkout -b feature-name)
  3. Make your changes
  4. Commit your changes (git commit -am 'Add new feature')
  5. Push to the branch (git push origin feature-name)
  6. Open a pull request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements