|
| 1 | +<p align="center"> |
| 2 | + <img src="https://i.imgur.com/ElCDWZb.png" width=400px height=300px> |
| 3 | + <h1 align="center"> Postman Student Helper </h1> |
| 4 | + <p align="center"> |
| 5 | + <b>This is the main repository of the Postman Student Helper Discord Bot. </b> |
| 6 | + </p> |
| 7 | +</p> |
| 8 | + |
| 9 | +## About : |
| 10 | + |
| 11 | +Postman Student Helper is a Discord Bot developed by Postman Student Leaders. It's main aims are to help make the Postman Student Community Discord a better place by using moderation and fun commands ! |
| 12 | + |
| 13 | +## Note to all developers |
| 14 | +Be sure to not commit directly to the main. Happy coding ! |
| 15 | + |
| 16 | +## Prerequisites |
| 17 | + |
| 18 | +### System requirement |
| 19 | + |
| 20 | +1. Any system with basic configuration. |
| 21 | +2. Operating System : Windows / Linux / Mac |
| 22 | + |
| 23 | +### Software requirement |
| 24 | + |
| 25 | +1. Node.JS |
| 26 | +2. Git |
| 27 | + |
| 28 | +(Docker is nice but not required to run the project locally) |
| 29 | + |
| 30 | +### Skill requirement |
| 31 | + |
| 32 | +1. Git & Github |
| 33 | +2. Node.JS |
| 34 | +3. Discord.JS |
| 35 | +4. TypeScript |
| 36 | + |
| 37 | +## Running the Project Locally |
| 38 | + |
| 39 | +### Setting Up The Application |
| 40 | + |
| 41 | +1. Clone the project with `git clone` and `cd` into it |
| 42 | +2. change the name of `.sampledotenv` to `.env` |
| 43 | +3. Get your secret key from [Discord Developer Portal](https://discord.com/developers/applications) and put it in the `.env` |
| 44 | +4. Run `yarn install` or `npm install` |
| 45 | +5. At `node_modules\bing-translate-api\src\index.js (line 128)` add `.toString().`before the `.trim().` |
| 46 | +6. You are good to go! Now you can start the project by typing `yarn start` or `npm start` to your command line |
| 47 | + |
| 48 | +## Commands |
| 49 | + |
| 50 | +#### Active Commands |
| 51 | +- `!p translate <text>` -> Translate a message from another language to English |
| 52 | +- `!p help`-> Displays all commands |
| 53 | +- `!p programs` -> List all programs |
| 54 | + |
| 55 | +#### Silent Commands |
| 56 | +- `Scam Detection` -> Every message is scanned for scams |
| 57 | + |
| 58 | +## Contributors : |
| 59 | + |
| 60 | +<a href = "https://github.com/ctnkaan/postman-student-helper/graphs/contributors"> |
| 61 | + |
| 62 | +<img src = "https://contrib.rocks/image?repo=ctnkaan/postman-student-helper"/> |
| 63 | + |
| 64 | +</a> |
0 commit comments