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

Contents of /trunk/README.md

Parent Directory Parent Directory | Revision Log Revision Log


Revision 173 - (show annotations)
Mon Jul 29 17:28:53 2024 UTC (8 months ago) by rakin
File MIME type: text/markdown
File size: 1483 byte(s)
doc: update readme
1 <p align="center">
2 <img src="https://res.cloudinary.com/rakinar2/image/upload/v1651761676/sudobot4_r257uw.png" height="200px" width="200px">
3 </p>
4
5 <h1 align="center">SudoBot</h1>
6
7 <p align="center">
8 <a href="https://github.com/onesoft-sudo/sudobot/actions/workflows/build.yml"><img src="https://github.com/onesoft-sudo/sudobot/actions/workflows/build.yml/badge.svg" alt="Build"></a>
9 <img src="https://img.shields.io/github/license/onesoft-sudo/sudobot?label=License" alt="GitHub">
10 <img src="https://img.shields.io/github/package-json/v/onesoft-sudo/sudobot?label=Version" alt="GitHub package.json version">
11 <img src="https://img.shields.io/github/commit-activity/w/onesoft-sudo/sudobot?label=Commit%20Activity" alt="GitHub commit activity">
12 </p>
13
14 <p align="center">
15 A Discord bot for moderation purposes.
16 </p>
17
18 ### Getting started
19
20 You can request an invite for SudoBot [here](https://sudobot.everything-server.ml/).
21 Alternatively, you can create your own Discord API application and then host SudoBot.
22
23 ### Setup for Custom Hosting
24
25 First, download the latest release or clone the repo by running:
26
27 ```
28 git clone https://github.com/onesoft-sudo/sudobot
29 ```
30
31 Then go inside the project directory, and run the following commands:
32
33 ```
34 sh init.sh
35 touch config/config.json .env
36 echo "{}" > config/snippets.json
37 npm install
38 npm install -D
39 ```
40
41 Build the project:
42
43 ```
44 npm run build
45 ```
46
47 Deploy slash commands globally:
48
49 ```
50 node deploy-commands.js
51 ```
52
53 Start the bot:
54
55 ```
56 npm start
57 ```

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26