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

Diff of /trunk/README.md

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

revision 457 by rakin, Mon Jul 29 17:30:20 2024 UTC revision 458 by rakin, Mon Jul 29 17:30:20 2024 UTC
# Line 43  Alternatively, you can create your own D Line 43  Alternatively, you can create your own D
43  * A Discord Webhook URL for sending error reports  * A Discord Webhook URL for sending error reports
44  * 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)
45    
46  First, download the latest release or clone the repo by running:  ### Setup steps
47    
48    1. Download the latest release or clone the repo by running:
49    
50  ```  ```
51  git clone https://github.com/onesoft-sudo/sudobot  git clone https://github.com/onesoft-sudo/sudobot
52  ```  ```
53    
54  Then go inside the project directory, and run the following command:  2. Go inside the project directory, and run the following command:
55    
56  ```  ```
57  npm install -D  npm install -D
58  ```  ```
59    
60  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:
61    
62  ```json  ```json
63  {  {
# Line 77  Then open up the `config/config.json` fi Line 79  Then open up the `config/config.json` fi
79    
80  **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.
81    
82  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.
83    
84    4. Copy the `.env.example` file to `.env` and open it, edit the information (such as bot token. MongoDB URI, etc) as needed.
85    
86  Build the project:  5. Build the project:
87    
88  ```  ```
89  npm run build  npm run build
90  ```  ```
91    
92  Deploy slash commands globally:  6. Deploy slash commands globally:
93    
94  ```  ```
95  node deploy-commands.js  node deploy-commands.js
96  ```  ```
97    
98  Start the bot:  7. Start the bot:
99    
100  ```  ```
101  npm start  npm start
Legend:
Removed from v.457  
changed lines
  Added in v.458
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26