Skip to content

Commit

Permalink
Merge pull request #2 from JiyaGupta-cs/main
Browse files Browse the repository at this point in the history
Readme Update
  • Loading branch information
Mr-Sunglasses authored Jun 21, 2024
2 parents d980e06 + d2f591d commit 37750dd
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,43 @@ The FOSSCU_Tomodachi is a FOSSCU-K Discord Bot is a versatile Discord bot design
- `!xps`: Display the XPs of the members
- `!issues`: Fetch and display open issues
- `!members`: Fetch and display organization members

## Installation

1. **Clone the Repository**

```bash
git clone https://github.com/FOSS-Community/fosscu-discord-bot.git
cd fosscu-discord-bot
```


2. **Set Up GitHub Token**

- Create a personal access token on GitHub with the necessary permissions to read organization members, repositories, issues, and pull requests and set up in the environment variables.

3. **Run Initialization Script**

Execute the `init.sh` script to interactively set up the bot:

```bash
npm i
```

4. **Start Server**

```bash
npm start
```

If installed nodemon as dev dependency

```bash
npm run dev
```


**Invite Discord Bot in your Server**



0 comments on commit 37750dd

Please sign in to comment.