Skip to content

Commit 10b817d

Browse files
authored
Merge pull request #12 from cameronlxu/codeShare
v2.2 - /codeshare
2 parents 022e034 + 7a7019b commit 10b817d

File tree

6 files changed

+1576
-21
lines changed

6 files changed

+1576
-21
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ Leetcode Tracker is Discord Bot that assists users with keeping track of their l
66

77
The main focus is allowing the users to input the link of the completed problem and the bot will store that information in a database which can be viewed at a later time. With this, users will to see their current progress - whether a statistical overview or a full view list of all the problems he/she has completed separated by category & chronological order. Lastly to "game-ify" their experience, there is a ranking system that compares against the Total/Easy/Medium/Hard problem count completed amongst all users.
88

9-
On the technical side, the discord bot uses JavaScript on the front end to interact with the user and the code is hosted on [Oracle Cloud Infrastructure Compute Service](https://docs.oracle.com/en-us/iaas/Content/Compute/Concepts/computeoverview.htm) through a Virtual Machine. The process of the bot is kept alive using a daemon process manager: [pm2](https://pm2.keymetrics.io). The backend is entirely made up of [Amazon Web Services](https://aws.amazon.com), more specifically [API Gateway](https://aws.amazon.com/api-gateway/?nc2=type_a), [Lambda](https://aws.amazon.com/lambda/?nc2=type_a), & [DynamoDB](https://aws.amazon.com/dynamodb/?nc2=type_a). The bot makes API calls to either create, update, or retrieve data stored in the NoSQL database.
9+
On the technical side, the discord bot uses JavaScript on the front end to interact with the user and the code is hosted on [Oracle Cloud Infrastructure Compute Service](https://docs.oracle.com/en-us/iaas/Content/Compute/Concepts/computeoverview.htm) through a Virtual Machine. The process of the bot is kept alive using a daemon process manager: [pm2](https://pm2.keymetrics.io). The backend is entirely made up of [Amazon Web Services](https://aws.amazon.com), more specifically [API Gateway](https://aws.amazon.com/api-gateway/?nc2=type_a), [Lambda](https://aws.amazon.com/lambda/?nc2=type_a), & [DynamoDB](https://aws.amazon.com/dynamodb/?nc2=type_a). The bot makes API calls to either create, update, or retrieve data stored in the NoSQL database. Other libraries used are [Puppeteer](https://pptr.dev) and [Cron](https://www.npmjs.com/package/cron).
1010

1111
### Current Requirements
1212
- [x] `/create` to only create an account (once)
1313
- [x] `/complete` to input the link of the newly completed problem which will add to their problems completed
1414
- [x] `/progress` to retrieve their data in a statistical overview or problem list layout
1515
- [x] `/ranking` to view the rankings (problem count) based on a difficulty chosen: Easy, Medium, Hard, Total
1616
- [x] `/help` to see what the Leetcode Tracker bot is along with its functionalities
17+
- [x] `/codeshare` to generate a new codeshare link that will expire after 24 hours
1718
- [x] Responses are in an [embed](https://discordjs.guide/popular-topics/embeds.html#embed-preview) format
1819

1920
### Future TODO List
@@ -73,13 +74,16 @@ On the technical side, the discord bot uses JavaScript on the front end to inter
7374
![bot response for rankings](https://user-images.githubusercontent.com/12592121/221268651-bcb99992-0394-43ac-8b7d-3bfd2a1266dd.png)
7475

7576

76-
7777
## /help
7878
- If a user wants to learn more information about the Leetcode Tracker bot or about the available commands, this command is for them
7979

8080
![/help command response](https://user-images.githubusercontent.com/12592121/221268730-899dc9e9-dbbf-4d97-bace-e230d1039a1c.png)
8181

8282

83+
## /codeshare
84+
- If a user wants to create a codeshare link, they are able to with this command
85+
86+
![/codeshare command response](https://user-images.githubusercontent.com/12592121/235514716-fe0d5fe1-bb78-48b3-99c9-194bd6218ec5.png)
8387
----------
8488

8589
## 🖥️ Technical Architecture

0 commit comments

Comments
 (0)