Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 1.81 KB

README.md

File metadata and controls

75 lines (47 loc) · 1.81 KB
Raw

vexibot

Discord bot that provides services related to the VEX Robotics Competition, primarily providing information and statistics related to the competition.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Environment Variables

Variable Required Default Description
DISCORD_TOKEN ✓ Token of the Discord account to log in with
ROBOT_EVENTS_TOKEN ✓ Robot Events API token
LOG_LEVEL INFO Minimum log level
NODE_ENV development Node.JS application environment

Installing

Install dependencies

yarn install

Start the bot

yarn dev

Running the tests

yarn test

Deployment

Install dependencies

yarn install

Compile source

yarn build

Start the bot

yarn start

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

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