https://github.com/fb-sean/vote-logger
📈 A simple vote logger with some cool helpers like ws
https://github.com/fb-sean/vote-logger
Last synced: about 2 months ago
JSON representation
📈 A simple vote logger with some cool helpers like ws
- Host: GitHub
- URL: https://github.com/fb-sean/vote-logger
- Owner: fb-sean
- License: other
- Created: 2024-01-31T17:18:44.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-01T18:19:02.000Z (over 1 year ago)
- Last Synced: 2025-02-12T03:17:04.186Z (3 months ago)
- Language: JavaScript
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vote-Logger
## Introduction
**Vote-Logger** is a really simple NodeJs process to run a vote logger that saves the vote into redis and also has a websocket to log votes external.
## How to Use
To get started with Vote-Logger:
1. **Explore the Code:** Familiarize yourself with the source code to understand how everything works and how websockets are used for communication between services.
2. **Clone and Configure:** Clone this repository to your local machine. Before running the application, you'll need to set up your configuration files as described below.
3. **Understand the License:** Ensure you read and comply with the license terms of this repository.
## Configuration Files
You need to create and configure the following JSON files:
### `src/CONFIGS/auth.json`
This file contains authentication tokens necessary for Redis and websocket communication.
### `src/CONFIGS/bots.json`
This file specifies the allowed bots there auth tokens for the Botlists and the vote length how long the vote counts.
### `src/CONFIGS/port.json`
This file specifies the ports the service should run on.
```json
{
"httpPort": 8080,
"wsPort": 8081
}
```
### `src/CONFIGS/botlists.json`
This file can be ignored its only there to identify the current requesting botlist.
## Contributions and Feedback
Your contributions and feedback are welcome to improve this project. Feel free to submit issues or pull requests for enhancements.