Merge pull request #6 from derogab/dev

v1.4.1

Author: derogab

.dockerignore

@@ -0,0 +1,7 @@
+# Node
+node_modules
+# Logs
+logs/*.log
+# Private contents
+private/*
+!private/*.tpl

.gitignore

@@ -1,4 +1,7 @@
-config.yml
+# Node
 node_modules
+# Logs
 logs/*.log
-routes/explicit.js
+# Private contents
+private/*
+!private/*.tpl

Dockerfile

@@ -0,0 +1,16 @@
+FROM node:10
+
+# Create app directory
+WORKDIR /bot
+
+# Install app dependencies
+# A wildcard is used to ensure both package.json AND package-lock.json are copied
+# where available (npm@5+)
+COPY package*.json ./
+RUN yarn
+
+# Copy app
+COPY . .
+
+# Run command 
+CMD [ "node", "bot.js" ]

README.md

@@ -3,17 +3,24 @@
 </p>
 <h2 align="center">A clown bot to cheer up conversations in own university chat group</h2>
 
-### Installation
-```
-npm install
-```
-
 ### Configuration
-Copy `config.yml.tpl` template in `config.yml` w/ your info.
+Copy `config.yml.tpl` template in `config.yml` with your info.
 
-### Usage
+### Extra
+Copy `extra.js.tpl` template in `extra.js` to add extra features.
+
+### Start 
+##### Using docker
+```
+docker run \
+  -dit \
+  --mount type=bind,source=/path/to/host/private/,target=/bot/private \
+  derogab/unisharebot
+```
+Replace `/path/to/host/private/` with absolute path to your private folder (containing config and extra).
+##### Using source
 ```
-npm start
+npm install && npm start
 ```
 
 ### License

bot.js

@@ -7,7 +7,7 @@ const YAML = require('yaml');
  * =====================
  * Get data from /config.yml and /package.json
  */
-const file = fs.readFileSync('./config.yml', 'utf8');
+const file = fs.readFileSync('./private/config.yml', 'utf8');
 const config = YAML.parse(file);
 const info = require('./package.json');
 
@@ -42,14 +42,14 @@ require(__dirname + '/routes/callbacks')(bot, info, config, auth);
 require(__dirname + '/routes/inline_query')(bot, info, config, auth);
 
 /**
- * Router Explicit
+ * Router Extra
  * =====================
- * Uncensored content / Parental Advisory disabled
+ * Extra private contents
  */
 
-fs.stat('routes/explicit.js', function(err, stat) {
+fs.stat('private/extra.js', function(err, stat) {
     if(err == null) {
-        require(__dirname + '/routes/explicit')(bot, info, config, auth);
+        require(__dirname + '/private/extra')(bot, info, config, auth);
     } 
 });