Schedule Bot

Welcome to the documentation for ScheduleBot - A bot created display when your next class is scheduled.

Table of Contents

1. Project Overview
2. Prerequisites
3. Getting Started
   • Installing Dependencies
   • Configuring .env
   • Starting the Bot
4. Usage
5. Contributing
6. License

Project Overview

This Discord.js bot is designed to display information about your upcoming classes in school.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js
• npm (Node Package Manager)
• Git (Optional, but recommended for version control)

Getting Started

Installing Dependencies

1. Clone this repository to your local machine:

   git clone https://github.com/your-username/your-discord-bot.git

2. Navigate to the project directory:

   cd ScheduleBot

3. Install the project dependencies:

   npm install

Configuring .env

Create a .env file in the root directory of your project and fill in the following values:

CLIENT_TOKEN = your_bot_token_here

Replace your_bot_token_here with your Discord bot token

Starting the Bot

Run the following command to start your bot:

npm start

Your Discord bot should now be online and ready to respond to commands.

Usage

This bot does not accept any form of user input, it reads everything from the json_files directory.

Contributing

If you'd like to contribute to this project, please create an issue describing what you are changing and follow that with a pull request.

License

Anyone is free to use or modify this source code.