/SteamWatch

A Discord bot for keeping track of Steam apps

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Logo

Steam Watch

A Discord bot for keeping track of Steam apps.

Discord server Dependencies License Version

Getting Started

To get a local copy up and running follow these simple steps:

Prerequisites

Installation

  1. Clone the repo
git clone https://github.com/dukeofsussex/SteamWatch.git
  1. Install NPM packages
npm install
  1. Configure the bot by copying .env.example to .env and setting the provided parameters
  2. (Optional) Build the bot for production
npm run build:<package>
  1. Run the bot
# development
npm run dev:<package>

# production
cd <path to package>
node .

Contributing

Any contributions made are welcome and greatly appreciated.

  1. Fork the project
  2. Create your feature branch (git checkout -b feature)
  3. Code it
  4. Commit your changes (git commit -m 'Add something awesome')
  5. Push to the branch (git push origin feature)
  6. Open a Pull Request

License

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