2 |
3 | 
4 |
5 |
Code Competition Watcher
6 | A Telegram Bot that serves you a catalog of ongoing and upcoming coding contests on various programming websites so that you never miss out on any of the contests.
7 |
8 |
9 | ---
10 | [](https://dsc.community.dev/vellore-institute-of-technology/)
11 | [](https://discord.com/invite/cWyEXgV)
12 |
13 | [](INSERT_LINK_FOR_DOCS_HERE)
14 | [](INSERT_UI_LINK_HERE)
15 |
16 |
17 | ## Functionalities
18 | - [ ] Upcoming contest details
19 | - [ ] Ongoing contest details
20 | - [ ] Editorial Support Post Contest
21 | - [ ] Reminders before contests
22 | - [ ] Blogs from Competitive Coding Websites
23 |
24 |
25 |
26 | ## Instructions to run
27 |
28 | * Pre-requisites:
29 |
30 | - NodeJS and NPM installed
31 |
32 | - Newly generated Bot token for initialisation
33 |
34 | [comment]: <> (* )
35 |
36 | [comment]: <> (```bash)
37 |
38 | [comment]: <> (< insert code >)
39 |
40 | [comment]: <> (```)
41 |
42 | * Clone the repo, install all the dependencies and run the following command:
43 |
44 | ```bash
45 | npm start
46 | ```
47 |
48 | ## Contributors
49 |
50 |
24 | 25 | 26 | ## Instructions to run 27 | 28 | * Pre-requisites: 29 | 30 | - NodeJS and NPM installed 31 | 32 | - Newly generated Bot token for initialisation 33 | 34 | [comment]: <> (* ) 35 | 36 | [comment]: <> (```bash) 37 | 38 | [comment]: <> (< insert code >) 39 | 40 | [comment]: <> (```) 41 | 42 | * Clone the repo, install all the dependencies and run the following command: 43 | 44 | ```bash 45 | npm start 46 | ``` 47 | 48 | ## Contributors 49 | 50 |
|
55 |
56 | Md Hishaam Akhtar
57 |
58 |
59 |
62 | |
68 |
69 |
70 |
71 |
72 | Abdeali Jaroli
73 |
74 |
75 |
78 | |
84 |
85 |
86 |
87 |
88 |
89 | Anshul Bamb
90 |
91 |
92 |
95 | |
101 |
60 | 
65 | 105 | Made with :heart: by DSC VIT 106 |
107 | 108 | -------------------------------------------------------------------------------- /contributing.md: -------------------------------------------------------------------------------- 1 | ## Contribution Guidelines 2 | 3 | Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. 4 | 5 | ## How to contribute 6 | 7 | - Decide which repository to contribute 8 | - Decide what to contribute 9 | - Fork the repo then clone it locally 10 | - Commit your work (You should create a new branch when you're doing development work that is somewhat experimental in nature. ) 11 | - Watch how to make a [Pull Request](https://www.youtube.com/watch?v=RVf9nXslJIc) 12 | - Congrats 🎉 you have just contributed towards open source! 13 | 14 | ## What to contribute 15 | 16 | - Find an open issue to tackle 17 | - Ask if you can help write a new feature, discord invite link [here](https://discord.com/invite/cWyEXgV) 18 | - Add / Improve Unit Testing 19 | - Write tutorials for how a project can be used and add to the readme 20 | - Review code on other people’s submissions and help improving / finding vulnerabilities 21 | 22 | ## Making a PR 23 | - Provide all the appropriate details asked in PR template 24 | - A pull request doesn’t have to represent finished work. It’s usually better to open a pull request early on, so others can watch or give feedback on your progress. Just mark it as a “WIP” (Work in Progress) in the subject line. You can always add more commits later. 25 | 26 | ## Opening an Issue 27 | - Make use of an appropriate Issue Template 28 | - We welcome Feature request, Bug Report, Documentation fix and others 29 | - Do not open critical secuirty issues here, report them directly at [discord](https://discord.com/invite/cWyEXgV) to an inner-core member only 30 | 31 | ## Communicating effectively 32 | **Give context.** Help others get quickly up to speed. If you’re running into an error, explain what you’re trying to do and how to reproduce it. If you’re suggesting a new idea, explain why you think it’d be useful to the project (not just to you!). 33 | 34 | ``` 35 | ✔️ “X doesn’t happen when I do Y” 36 | ❌ “X is broken! Please fix it.” 37 | ``` 38 | 39 | **Do your homework beforehand.** It’s OK not to know things, but show that you tried. Before asking for help, be sure to check a project’s README, documentation, issues (open or closed), mailing list, and search the internet for an answer. People will appreciate when you demonstrate that you’re trying to learn. 40 | 41 | ``` 42 | ✔️ ““I’m not sure how to implement X. I checked the help docs and didn’t find any mentions.”” 43 | ❌ “How do I X?” 44 | ``` 45 | 46 | **Keep requests short and direct.** 47 | 48 | ``` 49 | ✔️ “I’d like to write an API tutorial.” 50 | ❌ “I was driving down the highway the other day and stopped for gas, and then I had this amazing idea for something we should be doing, but before I explain that, let me show you…“ 51 | ``` 52 | 53 | **It’s okay to ask questions (but be patient!).** 54 | 55 | ``` 56 | ✔️ “Thanks for looking into this error. I followed your suggestions. Here’s the output.” 57 | ❌ “Why can’t you fix my problem? Isn’t this your project?” 58 | ``` 59 | 60 | **Respect community decisions.** 61 | 62 | ``` 63 | ✔️ “I’m disappointed you can’t support my use case, but as you’ve explained it only affects a minor portion of users, I understand why. Thanks for listening.” 64 | ❌ “Why won’t you support my use case? This is unacceptable!” 65 | ``` 66 | 67 | ## Misc 68 | - You are welcome to Propose a new feature or other project idea at our [ideas website](ideas.dscvit.com/) 69 | - You may Discuss a high-level topic or idea (for example, community, vision or policies) at our [Discord](https://discord.com/invite/cWyEXgV) Server 70 | 71 | ## Attribution 72 | - [Open Source Guide](https://opensource.guide/how-to-contribute/) 73 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "template-ts", 3 | "version": "1.0.0", 4 | "description": "TypeScript version of our Node.js template", 5 | "main": "src/app.ts", 6 | "scripts": { 7 | "build": "npm run lint && tsc", 8 | "build-nolint": "tsc", 9 | "test": "mocha -r ts-node/register src/tests/*", 10 | "dev": "nodemon --exec ts-node src/app.ts", 11 | "start": "node dist/app.js", 12 | "lint": "standardx **/*.ts --fix", 13 | "coverage": "tsc && nyc --reporter=lcov mocha dist/tests/* && codecov" 14 | }, 15 | "repository": { 16 | "type": "git", 17 | "url": "git+https://github.com/smoke-trees/node-template-ts.git" 18 | }, 19 | "keywords": [ 20 | "nodejs", 21 | "template", 22 | "typescript" 23 | ], 24 | "author": "SmokeTrees", 25 | "license": "MIT", 26 | "bugs": { 27 | "url": "https://github.com/smoke-trees/node-template-ts/issues" 28 | }, 29 | "homepage": "https://github.com/smoke-trees/node-template-ts#readme", 30 | "eslintConfig": { 31 | "rules": { 32 | "no-unused-vars": "off", 33 | "@typescript-eslint/no-unused-vars": "error" 34 | } 35 | }, 36 | "standardx": { 37 | "parser": "@typescript-eslint/parser", 38 | "plugins": [ 39 | "@typescript-eslint/eslint-plugin" 40 | ] 41 | }, 42 | "dependencies": { 43 | "axios": "^0.21.1", 44 | "dotenv": "^8.2.0", 45 | "logger": "0.0.1", 46 | "node-schedule": "^2.0.0", 47 | "redis": "^3.0.2", 48 | "telegraf": "^3.38.0", 49 | "winston": "^3.3.3" 50 | }, 51 | "devDependencies": { 52 | "@types/logger": "0.0.0", 53 | "@types/lowdb": "^1.0.9", 54 | "@types/node": "^14.14.11", 55 | "@types/mocha": "^7.0.2", 56 | "@typescript-eslint/eslint-plugin": "^2.34.0", 57 | "@typescript-eslint/parser": "^2.34.0", 58 | "chai": "^4.2.0", 59 | "chai-http": "^4.3.0", 60 | "codecov": "^3.7.1", 61 | "eslint": "^6.8.0", 62 | "mocha": "^7.2.0", 63 | "nodemon": "^2.0.4", 64 | "nyc": "^15.0.1", 65 | "standardx": "^5.0.0", 66 | "ts-node": "^8.10.1", 67 | "typescript": "^3.9.3" 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /sample.env: -------------------------------------------------------------------------------- 1 | TOKEN= 2 | CLIENT_ID= 3 | CLIENT_SECRET= 4 | REDIS_URL= -------------------------------------------------------------------------------- /src/api/apiConstants.ts: -------------------------------------------------------------------------------- 1 | function addZero (i): string { 2 | if (i < 10) { 3 | i = '0' + i 4 | } 5 | return i 6 | } 7 | function timeConverter (unixTimestamp): string { 8 | const a = new Date(unixTimestamp * 1000) 9 | const months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'] 10 | const year = a.getFullYear() 11 | const month = months[a.getMonth()] 12 | const date = a.getDate() 13 | const hour = addZero(a.getHours()) 14 | const min = addZero(a.getMinutes()) 15 | return `${date} ${month} ${year} from ${hour}:${min}` 16 | } 17 | 18 | export function getCodeforcesString (name, id, startTimeSeconds): string { 19 | const formattedTime = timeConverter(startTimeSeconds) 20 | return `${name} starts on ${formattedTime}.` 21 | } 22 | 23 | export function getCodeChefStringUpcoming (name, code, startDate): string { 24 | const tempYear = startDate.substring(0, 4) 25 | const tempDay = startDate.substring(8, 10) 26 | const tempTime = startDate.substring(11, 16) 27 | const tempMonth = parseInt(startDate.toString().substring(5, 7)) 28 | const months = ['', 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'] 29 | let finalMonth = '' 30 | for (let i = 0; i <= months.length; i++) { 31 | if (tempMonth === i) { 32 | finalMonth = months[i] 33 | } 34 | } 35 | return `${name} starts on ${tempDay} ${finalMonth} ${tempYear} from ${tempTime}.` 36 | } 37 | 38 | export function getCodeChefStringRunning (name, code, endDate): string { 39 | const tempYear = endDate.substring(0, 4) 40 | const tempDay = endDate.substring(8, 10) 41 | const tempTime = endDate.substring(11, 16) 42 | const tempMonth = parseInt(endDate.toString().substring(5, 7)) 43 | const months = ['', 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'] 44 | let finalMonth = '' 45 | for (let i = 0; i <= months.length; i++) { 46 | if (tempMonth === i) { 47 | finalMonth = months[i] 48 | } 49 | } 50 | return `${name} ends on ${tempDay} ${finalMonth} ${tempYear} at ${tempTime}.` 51 | } 52 | 53 | export function getAtcoderString (title, id, startTimeSeconds): string { 54 | const formattedTime = timeConverter(startTimeSeconds) 55 | return `${title.substring(1)} starts on ${formattedTime}.` 56 | } 57 | 58 | export function getTime (startTimeSeconds): string { 59 | const formattedTime = timeConverter(startTimeSeconds) 60 | return formattedTime 61 | } 62 | 63 | export function getKickStart (name, startDate, startTime): string { 64 | return `${name} on ${startDate} at ${startTime}.` 65 | } 66 | -------------------------------------------------------------------------------- /src/api/atcoder/atcoder.ts: -------------------------------------------------------------------------------- 1 | import axios from 'axios' 2 | import { UpcomingContestResponse, ContestResponseSchema } from './interfaces' 3 | import { constants } from '../../constants' 4 | import { redisGet, redisSet } from '../../app' 5 | 6 | export async function upcomingContestsAtcoder (): Promise