Skip to content

Home

Jump to bottom
John edited this page Dec 18, 2024 · 2 revisions

Welcome to the trivia-bot Wiki!

This wiki provides detailed documentation about the trivia-bot, including how it works, its current status, and plans for future improvements.

Table of Contents

  1. Introduction
  2. Features
  3. Getting Started
  4. Configuration
  5. Usage
  6. Roadmap
  7. Contributing
  8. FAQ
  9. License

Introduction

The trivia-bot is a robust and extensible tool for scheduling and managing trivia quizzes. It allows users to create and schedule trivia games effortlessly while integrating with platforms like Twitter.

Features

  • Easy-to-use trivia scheduling system.
  • Integration with the Twitter API for updates or announcements.
  • Configurable and environment-variable support via .env.
  • Automated scheduling powered by node-schedule.

Getting Started

Prerequisites

  • Node.js: Version 14 or higher is recommended.
  • npm: Installed with Node.js.

Installation

  1. Clone the repository: 
    git clone https://github.com/tamecalm/trivia-bot.git
  2. Navigate to the project directory: 
    cd trivia-bot
  3. Install dependencies: 
    npm install

Configuration

  1. Create a .env file in the root of your project.
  2. Add the following variables to configure your bot: 
    TWITTER_API_KEY=your-twitter-api-key
TWITTER_API_SECRET=your-twitter-api-secret
TWITTER_ACCESS_TOKEN=your-twitter-access-token
TWITTER_ACCESS_SECRET=your-twitter-access-secret

Usage

Start the bot using:

npm start

Once started, the bot will:

  • Read the schedule from your configuration.
  • Post trivia reminders or questions on Twitter (if configured).

Roadmap

  • Basic scheduling functionality.
  • Integration with Twitter API.
  • Add support for other platforms.
  • Allow customization of trivia question formats.

Contributing

We welcome contributions! To get started:

  • Fork the repository.
  • Create a new branch for your feature or fix.
  • Submit a pull request with a clear description of your changes.

FAQ

  1. How can I add new trivia questions?
    Currently, trivia questions are added manually via the configuration file. Future updates will support dynamic input.

  2. Does the bot support other platforms besides Twitter?
    Not yet, but it's on the roadmap!

License

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

Clone this wiki locally