Skip to content

Commit 33fb7fa

Browse files
authored
Update README.md
1 parent a59279c commit 33fb7fa

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# TypeScript LeetCode Discord Bot
22

3-
This Discord bot is built to enhance the coding practice experience by integrating LeetCode challenges directly within your Discord server. It simplifies the process of accessing LeetCode problems, offering hints, and managing discussions through automated features. Developed using TypeScript and Node.js, this bot brings a structured approach to tackling coding problems as a community.
3+
This Discord bot is built to improve the process of preparing for technical interviews by integrating LeetCode challenges directly within your Discord server. It simplifies and automates the retrieval of LeetCode problems, topic tags, solution hints, as well as providing dedicated spaces for discussion and collaboration on problems. Developed using TypeScript and Node.js, this bot brings a structured approach to tackling interview problems as a community.
44

55
## Features
66

77
- **Daily Challenge Retrieval**: Fetches and posts the LeetCode question of the day in a specified channel.
8+
- **Tags on Demand**:
89
- **Hints on Demand**: Offers hints for LeetCode questions to aid users in finding solutions.
910
- **Roadmap Discussion Threads**: Automates the creation and management of daily threads for a series of questions following a predefined roadmap, encouraging focused group study sessions.
1011

@@ -17,7 +18,7 @@ This Discord bot is built to enhance the coding practice experience by integrati
1718
### Installation
1819

1920
1. **Clone the Repository**
20-
- Use `git clone <repository-url>` to clone this project to your local machine.
21+
- Use `git clone https://github.com/kengen1/Leetcode-Study-Bot.git` to clone this project to your local machine.
2122

2223
2. **Install Dependencies**
2324
- Change to the project directory and execute:
@@ -32,6 +33,8 @@ This Discord bot is built to enhance the coding practice experience by integrati
3233
DISCORD_TOKEN=<insert token>
3334
DISCORD_CLIENT_ID=<insert client id>
3435
DISCORD_CHANNEL_ID=<insert channel id>
36+
DISCORD_DAILY_CHALLENGE_CHANNEL_ID=<insert daily challenge channel id>
37+
DISCORD_ROADMAP_CHANNEL_ID=<insert roadmap channel id>
3538
```
3639
3740
4. **Start the Development Server**
@@ -45,13 +48,6 @@ This Discord bot is built to enhance the coding practice experience by integrati
4548
4649
Once the bot is operational on your Discord server, it can be interacted with using the following commands:
4750
48-
- **Help**: `!help` — Displays a list of available commands.
49-
- **Daily Challenge**: `!daily` — Retrieves and posts the LeetCode question of the day.
50-
- **Request a Hint**: `!hint <question-id>` — Provides a hint for the specified LeetCode question.
51-
52-
## Contributing
53-
54-
- **Branching**: For new features, bug fixes, or refactors, please create a separate branch prefixed accordingly with `feature/`, `bugfix/`, or `refactor/`, followed by a brief description of your work.
55-
- **Pull Requests (PRs)**: Once your work is ready for review, create a pull request against the main branch.
56-
- **Commit Categorization**: We use Gitmoji to categorize commits.
57-
- **Squashing Commits**: Before merging, squash your commits in your pull request to maintain a clean and linear project history. This practice simplifies reverting changes and understanding project evolution.
51+
- **Request a Random Problem to Solve**: `!random` - Creates a dedicated thread for a randomly selected leetcode problem.
52+
- **Request Topic Tags for a Problem**: `!tags` - Provides all available topic tags for a given question (This command can only be called within a question thread).
53+
- **Request a Hint**: `!hint` — Provides all hints for the specified LeetCode question, in hidden message format (This command can only be called within a question thread).

0 commit comments

Comments
 (0)