engineering
/
ramirez
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update requirements and add a start command to package.json

master
Miikka Virtanen 2017-07-24 02:46:55 +03:00
parent d4aa7d5fe4
commit 112556ad8d
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -6,13 +6,13 @@ Moderators and admins can then reply to these threads, and these responses are r
Inspired by Reddit's modmail system. Inspired by Reddit's modmail system.
## Setup ## Setup
1. Install Node.js 6 or higher 1. Install Node.js 8 or higher
2. Clone or download this repository 2. Clone or download this repository
3. Create a Discord server to be used as the modmail inbox 3. Create a Discord server to be used as the modmail inbox
4. Make a copy of the file `config.example.json` in the same folder and name the copy `config.json`. Open the file and fill in the values. 4. Make a copy of the file `config.example.json` in the same folder and name the copy `config.json`. Open the file and fill in the values.
5. Install dependencies: `npm install` 5. Install dependencies: `npm install`
6. Add bot to servers, and make sure to give it proper permissions on the mail server. 6. Add bot to servers, and make sure to give it proper permissions on the mail server.
7. Run the bot: `node src/index.js` 7. Run the bot: `npm start`
## Commands ## Commands

1
package.json
View File

@ -5,6 +5,7 @@
"license": "MIT", "license": "MIT",
"main": "src/index.js", "main": "src/index.js",
"scripts": { "scripts": {
"start": "node src/index.js",
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
}, },
"author": "", "author": "",