Taps-App Workshop Event Ticketing Telegram Bot

Table of Contents

• Introduction
• Features
• Installation
• Usage
• Configuration
• Database
• Contributing
• License

Introduction

Taps-App Workshop Event Ticketing Telegram Bot is a Telegram bot designed to handle event RSVPs. It allows users to register for events, join groups, and receive event-related information.

Features

• User registration for events
• Group invitation management
• Event information retrieval

Installation

To install and run this bot locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/yourusername/CEYLABS-INTERN-TGBOT-EVENTRSVP.git

2. Navigate to the project directory:

   cd CEYLABS-INTERN-TGBOT-EVENTRSVP

3. Install the dependencies:

   npm install

4. Update the src/config.sample.js file with your Telegram bot token and event group ID, then rename it as config.js:

   module.exports = {
   BOT_TOKEN: 'Your Bot Token Here', // bot`s token. You can get that in @BotFather
   GROUP_ID: 'Your Group ID Here' // // Group ID of the event group. You can get it using the /grpid command after adding the bot to the group.
   }

Usage

To start the bot, run the following command:

npm test

Configuration

1. Update the src/config.sample.js file with your Telegram bot token and event group ID.
2. Rename the updated config.sample.js file to config.js.

Here is what the config.sample.js file looks like:

module.exports = {
    BOT_TOKEN: 'Your Bot Token Here', // bot's token. You can get that from @BotFather
    GROUP_ID: 'Your Group ID Here'    // Group ID of the event group. You can get it using the /grpid command after adding the bot to the group.
};

// Please rename this file to config.js after you have filled in the values.

After renaming, your config.js file should not be tracked by git, so it will not be pushed to the repository with your sensitive data.

Database

User registration details are stored in the src/database.json file. The information stored includes the user's name, email, and the number of tickets they registered for.

Structure of database.json

The database.json file contains user data in the following format:

{
  "users": [
    {
      "name": "John Doe",
      "email": "[email protected]",
      "noOfTickets": 2
    },
    {
      "name": "Jane Smith",
      "email": "[email protected]",
      "noOfTickets": 1
    }
  ]
}

Contributing

We welcome contributions! Please fork the repository and submit a pull request for any improvements or bug fixes.

License

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