Merge pull request #59 from sfeir-open-source/v0.2

v0.2

Author: GildasMorel

.babelrc

@@ -9,7 +9,8 @@
                     "@event-bus": "./src/common/event-bus",
                     "@helpers": "./src/common/helpers",
                     "@client": "./src/client",
-                    "@server": "./src/server"
+                    "@server": "./src/server",
+                    "@config": "./config"
                 }
             }
         ]

.eslintignore

@@ -1,3 +1,5 @@
 node_modules/
 dist/
-showcase/
+showcase/
+docs-dist/
+docs-sources/

.gitignore

@@ -50,8 +50,11 @@ dist
 Thumbs.db
 
 # Slide show example
-showcase/reveal/node_modules/
-showcase/assets/slave
+showcase/resources/slave/
 
 # Parcel
-.cache
+.cache
+
+# Documentation
+docs-dist
+docs-sources/developers/code/parts/

.prettierignore

@@ -2,4 +2,6 @@ node_modules/
 package-lock.json
 dist/
 coverage/
-showcase/
+showcase/
+docs/
+docs-sources/

CONTRIBUTING.md

@@ -7,8 +7,8 @@
 
 There are two primary ways to help:
 
--   Using the issue tracker, and
--   Changing the code-base.
+-   Using the issue tracker
+-   Changing the code-base
 
 ## Using the issue tracker
 

README.md

@@ -1,72 +1,41 @@
-# Talk Control
-
-## Description
+# TalkControl
 
 This project aims to make speakers' life easier by supplying an app to remotely control their slideshow.
 
-It is composed by three main parts:
-
--   **Server** : it's the backend part of the app.
-
-    It has 2 purposes :
-
-    -   It receives and send events to master(s)
-    -   It stores the state of the app : slide number, etc...
-
-    Its job is to work as the **single source of truth** for the app.
-
--   **Master** : the master is a set of views for the speaker.
-
-    To control the talk, the master is the bridge between the slave(s) and the server.
-    It displays the slave(s) and listens for speaker events (key pressed, etc...), and send them to the server.
-    There are multiple master views, like :
-
-    -   The stage view : it displays the talk in an iframe in fullscreen
-    -   The presenter view : it displays the current slide, the next one, the timer and the notes
-
--   **Slave** : the slave is a technical component added to a view (for example : the slideshow, the timer, etc...) to update it from events sent by the server or the master.
-
-### Technology stack
-
-This app is written in plain javascript, tested with mocha and chai and bundled with parcelJs.
-
-### Status
+## Getting started
 
-Currently, this app is still in initial developpement phase.
+```bash
+npm i
+npm start
 
-## Dependencies
+# Then open a browser and go to url: http://localhost:1234/
+```
 
-For this to work you need to have Node.js v8 or more installed on your computer.
+## Documentation
 
-## Usage
+The documentation of this project can be generated with the following commands :
 
-Firstly install the dependencies
+```bash
+npm i # if not already done previously
+npm run jsdoc:build # build code documentation with JSDoc
+npm run docs:dev # build global documentation with vuepress
 
-```sh
-npm i
+# Then open a browser and go to url: http://localhost:8080/
 ```
 
-Then run the project
+## Help us
 
-```sh
-npm start
-```
+Feel free to add any issue that you might find useful to improve the project and even submit pull requests to help us :).
 
-Now you just need to open your browser on localhost:1234.
+You can go check our [issues page](https://github.com/sfeir-open-source/talk-control/issues)
 
-## How to test the software
+General instructions on _how to contribute_ can be found in the [CONTRIBUTING](CONTRIBUTING.md) file.
 
-Run tests
+## Troubleshoot
 
-```sh
-npm test
-```
-
-## Getting help
-
-Feel free to add any issue that you might find useful to improve the project and even propose pull request to help us :).
-You can go check our [issues page]('https://github.com/sfeir-open-source/talk-control/issues')
+In case of `Error: listen EADDRINUSE :::3000`, execute:
 
-## Getting involved
-
-General instructions on _how_ can be found in the [CONTRIBUTING](CONTRIBUTING.md) file.
+```bash
+lsof -i :3000
+kill -9 <PID>
+```

config/config.json

@@ -0,0 +1,8 @@
+{
+    "tcServer": {
+        "url": "http://localhost:3000"
+    },
+    "tcSlave": {
+        "keysBlocked": ["ArrowDown", "ArrowUp", "ArrowLeft", "ArrowRight", "Space"]
+    }
+}

docs-sources/.vuepress/config.js

@@ -0,0 +1,15 @@
+module.exports = {
+    title: 'TalkControl',
+    description: 'TalkControl documentation',
+    base: '/',
+    themeConfig: {
+        nav: [
+            { text: 'User guide', link: '/users/'},
+            { text: 'Developer guide', link: '/developers/'},
+            { text: 'JsDoc', link: '/developers/code/' },
+        ],
+        editLinks: true,
+        sidebarDepth: 1,
+        docsDir: "code/parts",
+    }
+}

docs-sources/README.md

@@ -0,0 +1,64 @@
+# Talk Control
+Welcome on TalkControl documentation. You can find a technical documentation [here](/developers/), instructions on how to use it [here](/users/) and a JsDoc [here](/developers/code/).
+
+## Description
+
+This project aims to make speakers' life easier by supplying an app to remotely control their slideshow.
+
+It is composed by three main parts:
+
+-   **Server** : it's the backend part of the app.
+
+    It has 2 purposes :
+
+    -   It receives and send events to master(s)
+    -   It stores the state of the app : slide number, etc...
+
+    Its job is to work as the **single source of truth** for the app.
+
+-   **Master** : the master is a set of views for the speaker.
+
+    To control the talk, the master is the bridge between the slave(s) and the server.
+    It displays the slave(s) and listens for speaker events (key pressed, etc...), and send them to the server.
+    There are multiple master views, like :
+
+    -   The stage view : it displays the talk in an iframe in fullscreen
+    -   The presenter view : it displays the current slide, the next one, the timer and the notes
+
+-   **Slave** : the slave is a technical component added to a view (for example : the slideshow, the timer, etc...) to update it from events sent by the server or the master.
+
+### Technology stack
+
+This app is written in plain javascript, tested with mocha and chai and bundled with parcelJs.
+
+### Status
+
+Currently, this app is still in initial developpement phase.
+
+## Dependencies
+
+For this to work you need to have Node.js v8 or more installed on your computer.
+
+## Usage
+
+First, install the dependencies
+
+```sh
+npm i
+```
+
+Then run the project
+
+```sh
+npm start
+```
+
+Now you just need to open your browser on localhost:1234.
+
+## How to test the software
+
+Run tests
+
+```sh
+npm test
+```