Skip to content

Commit 264017d

Browse files
committed
update readme
1 parent 306e440 commit 264017d

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,70 @@
11
# Mr.Plex
2+
23
Coderplex Discord Chat bot, for life.
4+
5+
## Requirements
6+
7+
- NodeJS & NPM/Yarn
8+
- Typescript
9+
10+
## Contributing guide
11+
12+
- First, fork the repository & clone it onto your local device
13+
14+
```sh
15+
git clone https://github.com/YOUR_USER_NAME/Mr.Plex && cd Mr.Plex
16+
```
17+
18+
- Install required dependencies
19+
20+
- with yarn
21+
22+
```sh
23+
yarn install
24+
```
25+
26+
- with npm
27+
28+
```sh
29+
npm install
30+
```
31+
32+
- Meanwhile, Open [Discord Developer Portal](https://discordapp.com/developers/) and create a new bot
33+
34+
- Copy the bot token and create a new file `.env` at the root of the project folder
35+
36+
- Add a new local env variable `BOT_TOKEN` into `.env`, example:
37+
38+
```dotenv
39+
BOT_TOKEN=YOUR_TOKEN_HERE
40+
```
41+
42+
- Now you can start building the bot
43+
44+
- with yarn
45+
46+
```sh
47+
yarn run build
48+
```
49+
50+
- with npm
51+
52+
```sh
53+
npm run build
54+
```
55+
56+
- In a seperate terminal, you can start the bot
57+
58+
- with yarn
59+
60+
```sh
61+
yarn run start
62+
```
63+
64+
- with npm
65+
66+
```sh
67+
npm run start
68+
```
69+
70+
- Invite the bot to your personal discord server and start hacking!

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy