Skip to content

Update README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kevinmonisit wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,21 @@ It is an easy consolidated way to access all the information a student may need
- [Stretch] Given specific event (idk how we do this) will ping user a reminder day of the event


### Installation

1. To start, make sure you have `python3` and `pip` installed.
2. Run the following commands
```bash
git clone git@github.com:Rutgers-CSL/RUCS-Discord-Bot.git
cd RUCS-Discord-Bot
python3 -m venv venv
source venv/bin/activate
pip3 install discord requests bs4 dotenv
touch .env
```
3. In the `.env` file, add your `DISCORD_TOKEN` and `GUILD_ID`. Refer to [Discord Develoepr Documentation](https://discord.com/developers/docs/resources/guild) for more details.
4. Run `python3 bot.py`

### Technical Implementation:

- Use of Python and JS (adam suggested python)
Expand Down