/[sudobot]/trunk/README.md
ViewVC logotype

Diff of /trunk/README.md

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 451 by rakin, Mon Jul 29 17:30:18 2024 UTC revision 514 by rakin, Mon Jul 29 17:30:36 2024 UTC
# Line 1  Line 1 
   
1  <p align="center">  <p align="center">
2  <img src="https://res.cloudinary.com/rakinar2/image/upload/v1659628446/SudoBot-new_cvwphw.png" height="200px" width="200px">  <img src="https://res.cloudinary.com/rakinar2/image/upload/v1659628446/SudoBot-new_cvwphw.png" height="200px" width="200px">
3  </p>  </p>
4    
5  <h1 align="center">SudoBot</h1>  <h1 align="center">SudoBot</h1>
6    
# Line 14  Line 13 
13  </p>  </p>
14    
15  <p align="center">  <p align="center">
16  A Discord bot for moderation purposes.  A Discord bot for moderation purposes. <a href="https://docs.sudobot.onesoftnet.eu.org/features/screenshots/">Click here</a> to see the screenshots.
17  </p>  </p>
18    
19  ### Features  ### Features
# Line 43  Alternatively, you can create your own D Line 42  Alternatively, you can create your own D
42  * A Discord Webhook URL for sending error reports  * A Discord Webhook URL for sending error reports
43  * A JWT Secret for the API services (if you don't have an API secret, you can run `openssl rand -base64 10` to generate a random base64 string and use it as secret)  * A JWT Secret for the API services (if you don't have an API secret, you can run `openssl rand -base64 10` to generate a random base64 string and use it as secret)
44    
45  First, download the latest release or clone the repo by running:  ### Setup steps
46    
47    1. Download the latest release or clone the repo by running:
48    
49  ```  ```
50  git clone https://github.com/onesoft-sudo/sudobot  git clone https://github.com/onesoft-sudo/sudobot
51  ```  ```
52    
53  Then go inside the project directory, and run the following command:  2. Go inside the project directory, and run the following command:
54    
55  ```  ```
56  npm install -D  npm install -D
57  ```  ```
58    
59  Then open up the `config/config.json` file and change at least the following:  3. Open up the `config/config.json` file and change at least the following:
60    
61  ```json  ```json
62  {  {
# Line 77  Then open up the `config/config.json` fi Line 78  Then open up the `config/config.json` fi
78    
79  **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.  **Note**: `...` means other options that exist in the config, you can edit them to customize the settings, but not required.
80    
81  Then copy the `.env.example` file to `.env` and open it, edit the information (such as bot token. MongoDB URI, etc) as needed.  > Alternatively, you can try the new `setup.js` installer script [BETA] by running `node setup.js`. It will ask you some questions about the configuration.
82    
83  Build the project:  4. Copy the `.env.example` file to `.env` and open it, edit the information (such as bot token. MongoDB URI, etc) as needed.
84    
85    5. Build the project:
86    
87  ```  ```
88  npm run build  npm run build
89  ```  ```
90    
91  Deploy slash commands globally:  6. Deploy slash commands globally:
92    
93  ```  ```
94  node deploy-commands.js  node deploy-commands.js
95  ```  ```
96    
97  Start the bot:  7. Start the bot:
98    
99  ```  ```
100  npm start  npm start
# Line 107  Then you can run the following command i Line 110  Then you can run the following command i
110  That should show the bot information.  That should show the bot information.
111  Congratulations! You've successfully set up your own instance of SudoBot!  Congratulations! You've successfully set up your own instance of SudoBot!
112    
113    ### Contributors
114    
115    Thanks to all the contributors!
116    
117    * [Ar Rakin](https://github.com/virtual-designer)
118    * [killerclaws12](https://github.com/killerclaws12)
119    
120  ### Support  ### Support
121    
122  - **Email**: [email protected]  - **Email**: [email protected]
123  - **Discord Servers**: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [Support Server](https://discord.gg/892GWhTzgs)  - **Discord Servers**: [The Everything Server](https://discord.gg/Km7ZcfXT6P), [Support Server](https://discord.gg/892GWhTzgs)
124    
125    ### Extra
126    
127    - **Dashboard**: The dashboard for SudoBot can be found [here](https://github.com/onesoft-sudo/sudobot-dashboard).
128    - **Download Emojis**: https://www.onesoftnet.eu.org/downloads/sudo/emojis/
Legend:
Removed from v.451  
changed lines
  Added in v.514
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26