From 26d00d01e736b9fa172e511dd10ce0e168dbddaf Mon Sep 17 00:00:00 2001 From: kingomes <83099848+kingomes@users.noreply.github.com> Date: Mon, 27 Jan 2025 13:07:56 -0600 Subject: [PATCH] added build instructions to docs --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index ab5f097..2fb72b5 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,9 @@ Features: - Submit and review user emojis - Fetch Issues and Pull Requests from github - Giveaway system + +## How to Build and Run the Sern Community Bot +1. Clone the repository +2. Create your .env file with the bot's token, which can be acquired by asking a lead developer for it +3. Run `yarn install` to install all necessary packages (If you do not have yarn installed, first run `npm install --global yarn`) +4. Run `npm run dev` or `npm run start` to build and run the bot \ No newline at end of file