├── .env-sample ├── .eslintrc.json ├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── bug_report.yml │ ├── config.yml │ ├── doc_report.yml │ ├── feature_request.yml │ └── other.yml ├── PULL_REQUEST_TEMPLATE.md └── workflows │ ├── greetings.yml │ ├── labels.yml │ ├── release.yml │ └── stale.yaml ├── .gitignore ├── .husky ├── commit-msg └── pre-commit ├── .huskyrc ├── .prettierrc ├── CODE_OF_CONDUCT.md ├── LICENSE ├── Procfile ├── README.md ├── commitlint.config.js ├── config.json ├── doc └── images │ ├── After_adding_bot.jpg │ ├── BotInstance.jpg │ ├── BotToken.jpg │ ├── Clone.jpg │ ├── Dashboard.jpg │ ├── Fork.jpg │ ├── HomePage.jpg │ ├── add_server.jpg │ └── app_id.jpg ├── docs ├── .nojekyll ├── CONTRIBUTING.md ├── _sidebar.md ├── commands │ ├── help.md │ ├── hey.md │ ├── links.md │ ├── meme.md │ ├── translate.md │ └── version.md ├── community.md ├── favicon.ico ├── images │ ├── discord_logo.svg │ ├── help.png │ ├── hey.png │ ├── links.png │ ├── meme.png │ ├── translate.png │ └── version.png ├── index.html └── index.md ├── index.js ├── package.json └── src ├── Commands ├── DSA.js ├── _COMMANDS.js ├── command.js ├── help.js ├── hey.js ├── links.js ├── meme.js ├── presence.js ├── restrictedWords.js ├── source.js ├── translate.js └── version.js ├── config └── IntentOptions.js ├── deprecated files ├── command.js ├── loadCommands.js └── presence.js ├── events ├── onInteraction.js ├── onMessage.js └── onReady.js ├── modules └── restrictedWords.js └── utils ├── botErrorHandler.js ├── botLogHandler.js └── validateEnv.js /.env-sample: -------------------------------------------------------------------------------- 1 | BOT_TOKEN=XXXXXXXXXXXXXXXX 2 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "es2020": true, 4 | "node": true 5 | }, 6 | "extends": [ 7 | "eslint:recommended", 8 | "plugin:prettier/recommended" 9 | ], 10 | "rules": { 11 | "linebreak-style": ["error", "unix"], 12 | "quotes": ["error", "single", { "allowTemplateLiterals": true }], 13 | "semi": ["error", "always"], 14 | "prefer-const": "error", 15 | "eqeqeq": ["error", "always"], 16 | "curly": ["error"] 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | # patreon: 4 | # ko_fi: 5 | # custom: 6 | # github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 7 | # open_collective: # Replace with a single Open Collective username 8 | # tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 9 | # community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 10 | # liberapay: # Replace with a single Liberapay username 11 | # issuehunt: # Replace with a single IssueHunt username 12 | # otechie: # Replace with a single Otechie username 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: Bug report 2 | description: Create a report to help us improve 3 | title: '[BUG] ' 4 | labels: ['💣type: bug'] 5 | body: 6 | - type: textarea 7 | attributes: 8 | label: Describe the bug 9 | description: A clear and concise description of what the bug is 10 | validations: 11 | required: false 12 | - type: textarea 13 | attributes: 14 | label: To Reproduce 15 | description: | 16 | Steps to reproduce the behavior. 17 | 1. Go to '...' 18 | 2. Click on '...' 19 | 3. Scroll down to '...' 20 | 4. See error 21 | validations: 22 | required: false 23 | - type: textarea 24 | attributes: 25 | label: Expected Behavior 26 | description: A clear and concise description of what you expected to happen. 27 | validations: 28 | required: false 29 | - type: textarea 30 | attributes: 31 | label: Screenshot/ Video 32 | description: If applicable, add screenshots to help explain your problem. 33 | validations: 34 | required: false 35 | - type: textarea 36 | attributes: 37 | label: Desktop (please complete the following information) 38 | description: | 39 | Device - [e.g. iPhone6] 40 | OS - [e.g. iOS8.1] 41 | Browser [e.g. stock browser, safari] 42 | Version [e.g. 22] 43 | validations: 44 | required: false 45 | - type: textarea 46 | attributes: 47 | label: Additional context 48 | description: Add any other context about the problem here. 49 | validations: 50 | required: false 51 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: Discord community support 4 | url: https://discord.gg/commclassroom 5 | about: Need any help? Found any bug? Please chat with us via Discord. 6 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/doc_report.yml: -------------------------------------------------------------------------------- 1 | name: Documentation request 2 | description: Change regarding improvising the docs to be more accessible 3 | title: '[DOCUMENTATION]' 4 | labels: ['✨ goal: improvement'] 5 | body: 6 | - type: checkboxes 7 | attributes: 8 | label: Describe the bug 9 | description: A clear and concise description of what the bug is 10 | options: 11 | - label: Information addition regarding the newest change through a PR. 12 | - label: Typo error. 13 | - label: New category addition. 14 | - label: Refractoring sentences that make more sense. 15 | - label: Fixing broken links. 16 | - label: Refractors / reformating of the document. 17 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yml: -------------------------------------------------------------------------------- 1 | name: Feature request 2 | description: Suggest an idea for this project 3 | title: '[FEATURE]' 4 | labels: ['⭐ goal: addition'] 5 | body: 6 | - type: textarea 7 | attributes: 8 | label: Is your feature request related to a problem? Please describe. 9 | description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 10 | placeholder: Ex. I'm always frustated when [...] 11 | validations: 12 | required: false 13 | - type: textarea 14 | attributes: 15 | label: Describe the solution you'd like 16 | description: A clear and concise description of what you want to happen. 17 | validations: 18 | required: false 19 | - type: textarea 20 | attributes: 21 | label: Describe alternatives you've considered 22 | description: A clear and concise description of any alternative solutions or features you've considered. 23 | validations: 24 | required: false 25 | - type: textarea 26 | attributes: 27 | label: Additional context 28 | description: Add any other context or screenshots about the feature request here. 29 | validations: 30 | required: false 31 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/other.yml: -------------------------------------------------------------------------------- 1 | name: Other 2 | description: Use this for any other issues. PLEASE do not create blank issues 3 | title: "[OTHER]" 4 | labels: ["🚦 status: awaiting triage"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: "# Other issue" 9 | - type: textarea 10 | id: issuedescription 11 | attributes: 12 | label: What would you like to share? 13 | description: Provide a clear and concise explanation of your issue. 14 | validations: 15 | required: true 16 | - type: textarea 17 | id: extrainfo 18 | attributes: 19 | label: Additional information 20 | description: Is there anything else we should know about this issue? 21 | validations: 22 | required: false 23 | - type: checkboxes 24 | id: consent 25 | attributes: 26 | label: Would you like to work on this issue? 27 | options: 28 | - label: Yes, I want to work on this issue! 29 | required: false 30 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | 4 | 5 | 6 | 7 | 11 | 12 | ## Check List (mark all applicable checkboxes) 13 | 14 | - [ ] My code follows the code style of this project. 15 | - [ ] My change requires a change to the documentation. 16 | - [ ] I have updated the documentation accordingly. 17 | - [ ] All new and existing tests passed. 18 | - [ ] This PR does not contain plagiarized content. 19 | - [ ] The title of my pull request is a short description of the requested changes. 20 | 21 | ## Screenshots (if applicable) 22 | 23 | Original | Updated 24 | :--------------------: |:--------------------: 25 | original screenshot | updated screenshot | 26 | -------------------------------------------------------------------------------- /.github/workflows/greetings.yml: -------------------------------------------------------------------------------- 1 | name: Greetings 2 | 3 | on: [pull_request_target, issues] 4 | 5 | jobs: 6 | welcome: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v1 10 | - uses: EddieHubCommunity/gh-action-community/src/welcome@main 11 | with: 12 | github-token: ${{ secrets.GITHUB_TOKEN }} 13 | issue-message: '

Hello 👋 Thank you very much for raising an issue 🙌 The maintainers will get back to you soon for discussion over the issue! Thank you for your contributions. 🚀

' 14 | pr-message: '

Yeah! You did it 🎉 Now, Relax 😉 -> Grab a drink ☕ -> And wait for the maintainers to check your contributions. Meanwhile, you can discuss on other issues and solve them 😀

' 15 | footer: 'If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord Server - we help and encourage each other to contribute to open source little and often 🤓 Any questions, let us know!' 16 | 17 | 18 | # name: Greetings 19 | 20 | # on: [pull_request, issues] 21 | 22 | # jobs: 23 | # greeting: 24 | # runs-on: ubuntu-latest 25 | # steps: 26 | # - uses: actions/first-interaction@v1 27 | # with: 28 | # repo-token: ${{ secrets.GITHUB_TOKEN }} 29 | # issue-message: 'Hello 👋, Thank you very much for raising an issue 🙌. The maintainers will get back to you soon for discussion over the issue!' 30 | # pr-message: 'Yeah! You did it 🎉. Now, Relax 😉 -> Grab a drink ☕ -> And wait for the maintainers views on your contribution. Meanwhile you can discuss on other issues and solve them 😀' 31 | -------------------------------------------------------------------------------- /.github/workflows/labels.yml: -------------------------------------------------------------------------------- 1 | name: Import open source standard labels 2 | 3 | on: 4 | push: 5 | branches: [ main, dev ] 6 | 7 | jobs: 8 | labels: 9 | 10 | runs-on: ubuntu-latest 11 | 12 | steps: 13 | - uses: actions/setup-node@v2 14 | with: 15 | node-version: '14' 16 | - uses: EddieHubCommunity/gh-action-open-source-labels@v0.2.2 17 | with: 18 | github-token: ${{ secrets.GITHUB_TOKEN }} 19 | owner-name: ${{ github.repository_owner }} 20 | repository-name: ${{ github.event.repository.name }} -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Changelog 2 | on: 3 | push: 4 | branches: 5 | - main 6 | 7 | jobs: 8 | changelog: 9 | runs-on: ubuntu-latest 10 | 11 | steps: 12 | - uses: actions/checkout@v2 13 | 14 | - name: Conventional Changelog Action 15 | id: changelog 16 | uses: TriPSs/conventional-changelog-action@v3 17 | with: 18 | github-token: ${{ secrets.GITHUB_TOKEN }} 19 | output-file: "false" 20 | 21 | - name: Create Release 22 | uses: actions/create-release@v1 23 | if: ${{ steps.changelog.outputs.skipped == 'false' }} 24 | env: 25 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 26 | with: 27 | tag_name: ${{ steps.changelog.outputs.tag }} 28 | release_name: ${{ steps.changelog.outputs.tag }} 29 | body: ${{ steps.changelog.outputs.clean_changelog }} 30 | -------------------------------------------------------------------------------- /.github/workflows/stale.yaml: -------------------------------------------------------------------------------- 1 | name: Mark stale issues and pull requests 2 | 3 | on: 4 | schedule: 5 | - cron: "30 1 * * *" 6 | 7 | jobs: 8 | stale: 9 | 10 | runs-on: ubuntu-latest 11 | 12 | steps: 13 | - uses: actions/stale@v1 14 | with: 15 | repo-token: ${{ secrets.GITHUB_TOKEN }} 16 | stale-issue-message: 'Stale issue message' 17 | stale-pr-message: 'Stale pull request message' 18 | stale-issue-label: 'no-issue-activity' 19 | stale-pr-label: 'no-pr-activity' -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /node_modules/ 2 | .env 3 | package-lock.json 4 | -------------------------------------------------------------------------------- /.husky/commit-msg: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | . "$(dirname "$0")/_/husky.sh" 3 | 4 | npx --no-install commitlint --edit "" 5 | -------------------------------------------------------------------------------- /.husky/pre-commit: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | . "$(dirname "$0")/_/husky.sh" 3 | 4 | -------------------------------------------------------------------------------- /.huskyrc: -------------------------------------------------------------------------------- 1 | { 2 | "hooks": { 3 | "pre-commit": "lint-staged" 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "endOfLine": "lf", 3 | "useTabs": true, 4 | "singleQuote": true 5 | } 6 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, caste, color, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | kaiwalyakoparkar@gmail.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.1, available at 119 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. 120 | 121 | Community Impact Guidelines were inspired by 122 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. 123 | 124 | For answers to common questions about this code of conduct, see the FAQ at 125 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available 126 | at [https://www.contributor-covenant.org/translations][translations]. 127 | 128 | [homepage]: https://www.contributor-covenant.org 129 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html 130 | [Mozilla CoC]: https://github.com/mozilla/diversity 131 | [FAQ]: https://www.contributor-covenant.org/faq 132 | [translations]: https://www.contributor-covenant.org/translations 133 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Community Classrooom 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /Procfile: -------------------------------------------------------------------------------- 1 | worker: node ./index.js 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 |

Classroom Monitor Bot

4 |

5 |

6 | This bot provides functionalities for the Community Classroom Discord server.

7 | Community Classroom is an initiative 'for the students, by the students'. The initiative aims to provide 'quality education which is free for all'.

8 | Follow us and be a part of this amazing community.

9 | 10 | 11 |   12 | 13 | 14 |   15 | 16 | 17 |   18 | 19 | 20 |   21 | 22 | 23 |   24 | 25 | 26 |
27 |

28 | 29 | ## About 30 | 31 | We believe that every student, irrespective of their college or branch, can make it big. Community Classroom is an initiative built on this thought. We provide hands-on training, mentorship and have an inclusive community. All of our courses are FREE and better than most paid courses. We cover every topic in detail and mentor you to stand out and get opportunities by breaking all the barriers. Get expert guidance with career, Open Source, and internships/jobs around the world. 32 | 33 | ## Note to all contributors 34 | 35 | Thank you for putting your time to contribute and helping others out!\ 36 | Before contributing do kindly read and follow [Code of Conduct](./CODE_OF_CONDUCT.md). 37 | 38 | To get started with contributing, go through the following steps. 39 | 40 | ## Prerequisites 41 | 42 | ### System requirements 43 | 44 | 1. Any system with basic configuration. 45 | 2. Operating System: Windows / Linux / Mac 46 | 47 | ### Software requirements 48 | 49 | 1. Node.js installed (If not download it [here](https://nodejs.org/en/download/)). 50 | 2. Any text editor of your choice (VSCode recommended). 51 | 3. Discord account and a Discord server where you have administrator access. 52 | 53 | ### Skill requirement 54 | 55 | 1. Basic Knowledge of Git & GitHub. 56 | 2. JavaScript 57 | 3. [NodeJS](https://nodejs.org/en/) 58 | 4. [expressJS](https://expressjs.com/) 59 | 60 | ## Setting up a local environment 61 | 62 | ### Forking repository 63 | 64 | 1. Firstly to make your copy of the project you have to fork the repository. To fork the repository, press the fork button. In case of any difficulties, refer to the image below 65 | ![fork](https://raw.githubusercontent.com/commclassroom/classroom-monitor-bot/main/doc/images/Fork.jpg) 66 | 67 | ### Clone repository 68 | 69 | 1. Now after you have forked the project, it's time to clone it into your local device so that you can work properly. 70 | 2. In your forked repository click on the green code button and copy the provided link. In case of any difficulties, refer to the image below 71 | ![clone](https://raw.githubusercontent.com/commclassroom/classroom-monitor-bot/main/doc/images/Clone.jpg) 72 | 73 | 3. Now on your desktop open Git Bash and type `git clone .git`, and press enter 74 | 4. Now, your forked repository has been cloned in your device! 🎉 75 | 76 | ## Contributing 77 | 78 | Before getting started, make sure you have Developer Mode enabled in your Discord. 79 | If you're not sure how to enable it, go to `Settings > Advanced > Developer Mode: ON` 80 | 81 | ### Creating a branch 82 | 83 | Whenever you want to contribute to any project, it is a good practice to make a separate branch and push it as a PR, rather than making changes to the main/master branch. 84 | 85 | 1. `git checkout -b ` will make a separate branch and will change to that branch 86 | 2. Now you are ready to make your changes. 87 | 88 | ### Setting up application and creating the bot 89 | 90 | 1. Go to the [Discord Developers Portal](https://discord.com/developers/applications/) page 91 | 2. Login with your Discord credentials. You will see the following screen (image below and for you, it will probably be a blank one) 92 | ![homepage](https://raw.githubusercontent.com/commclassroom/classroom-monitor-bot/main/doc/images/HomePage.jpg) 93 | 3. Now click the `New Application` button (refer to the image above) 94 | 4. Name your bot (it can be `Community Classroom bot` or anything else) and press `create` 95 | 5. You will be at the Developers Portal where you can customize your bot (refer to the image below) 96 | ![dashboard](https://raw.githubusercontent.com/commclassroom/classroom-monitor-bot/main/doc/images/Dashboard.jpg) 97 | 6. Now to create your bot instance go to the `Bot` tab, and press `Add Bot` followed by `Yes, do it` in the following popup (refer to the image below) 98 | ![bot instance](https://raw.githubusercontent.com/commclassroom/classroom-monitor-bot/main/doc/images/BotInstance.jpg) 99 | 7. You will be redirected to something similar to this screen 100 | ![after adding bot](https://raw.githubusercontent.com/commclassroom/classroom-monitor-bot/main/doc/images/After_adding_bot.jpg) 101 | 8. Go to `OAuth2` and copy the Client ID (refer to the image below) 102 | ![App ID](https://raw.githubusercontent.com/commclassroom/classroom-monitor-bot/main/doc/images/app_id.jpg) 103 | 9. Now to invite the bot to your server, paste this link in your browser `https://discord.com/api/oauth2/authorize?client_id=&permissions=8&scope=bot` and just replace `` with your copied client ID 104 | 10. You will be redirected to this screen (image below) where you have to select a server and click on `continue` and `authorize` after that 105 | ![Add server](https://raw.githubusercontent.com/commclassroom/classroom-monitor-bot/main/doc/images/add_server.jpg) 106 | 107 | ##### Amazing! You have added the bot to your server; although you might see it's offline. Let's make it go online! 108 | 109 | ### Coding our Bot 110 | 111 | 1. Open the folder of your cloned repository with any text editor of your choice (VSCode recommended) 112 | 2. Now go to the [Discord Developers Portal](https://discord.com/developers/) page where you created the bot and copy the bot token from the `Bot` tab (refer to the image below) 113 | ![Bot Token](https://raw.githubusercontent.com/commclassroom/classroom-monitor-bot/main/doc/images/BotToken.jpg) 114 | 3. Now create a file named`.env` in your root folder. Copy everything from the `.env-sample` file and replace the `BOT-TOKEN` value with the copied token. Note that the `.env` file should be nameless. Create a nameless file, with the extension `.env`. If you add a name to the file, NPM won't be able to access the token. 115 | 4. In the terminal run, `npm install`, this will install all the necessary packages 116 | 5. Start our server by running `npm start`. 117 | 6. All done! The bot is now online! 118 | 119 | ## Supported commands 120 | 121 | | Commands | Functionality | 122 | | ------------------------------------------------------------ | ------------------------------------------------------------ | 123 | | `cm!help` | Shows help with the commands, features, and what the bot offers | 124 | | `cm!hey` | Says `Hey` to the user | 125 | | `cm!version` | Displays the current version of the bot | 126 | | `cm!links` | Displays all the social accounts of the community | 127 | | `cm!translate ` | Translate the given text to English | 128 | | `cm!meme` | Send a meme from the [r/programmerhumor](https://www.reddit.com/r/ProgrammerHumor/) Reddit 129 | 130 | **This bot is reserved for functionalities offered for the Community Classroom community.** 131 | 132 | ## Commit Message 133 | 134 | After making the desired changes and testing, run the `git add .` command to add the files to the Git staging area. This area contains a list of all the files you have recently changed. 135 | 136 | `git commit -m ` to commit your changes and save them to the local repository. 137 | 138 | ##### We follow conventional commits specifications for our commit messages 139 | 140 | ### Commit Message Format 141 | 142 | Each commit message consists of a **header**, a **body**, and a **footer**. 143 | 144 | ```markdown 145 |
146 | 147 | 148 | 149 |