Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.64 KB

README.md

File metadata and controls

45 lines (27 loc) · 1.64 KB
Raw

JamJam

Verification Discord Bot for JAMHacks Hackathon hosted at the University of Waterloo

JAMHacks Website

JamJam Verify Command JamJam Response

Getting Started

To use JamJam on your own system follow these instructions

git pull https://github.com/Jamhacks-Hackathon/JamJam.git # Clone the JamJam repo on your system

# cd into the project directory

yarn # install all the dependencies using yarn
OR
npm i # install all the dependencies using npm

Rename .example.env file to .env and insert your credentials

yarn / npm dev # Run the Discord Bot

If you would like to host the bot using the replit method that was used for JAMHacks 7 please refer to Hosting a Discord bot on Repl.it

References

Naming Conventions (In some places the naming conventions were not followed due to how jamhacks.ca was constructed)

Eslint Rules

Discord.js Documentation

Discord.js Guide

Future Plans

JamJam functions as a basic user verification discord bot for JAMHacks. As of now, we plan to maintain this bot by keeping it up to date with Discord's API versions using discord.js npm package. In the future we may add more "fun" features or features to further assist the JAMHacks hackathon instead of just verifying users.

Contributors

JAMHacks 7 - Ayush Garg