/backend/README.md

https://github.com/deckgo/deckdeckgo · Markdown · 63 lines · 39 code · 24 blank · 0 comment · 0 complexity · bbf3bf868bba6ca254ef69ae0e63ee3e MD5 · raw file 

    

  1. # DeckDeckGo - Backend
    2. 

  2. 

  3. This project is a backend for [DeckDeckGo].
    4. 

  4. 

  5. It acts as the signaling server to let [DeckDeckGo]'s peers establish a real-time communication channel using [WebRTC](https://webrtc.org) for the remote control.
    6. 

    7. 

  7. It also transmits the information for the live voting when you are interacting with your audience.
    8. 

  8. 

  9. ## Table of contents
    10. 

  10. 

  11. - [Remote control](#remote-control)
    12. 

  12. 	- [Receiver](#receiver)
    13. 

  13. 	- [Emitter](#emitter)
    14. 

  14. - [Poll](#poll)
    15. 

  15. - [Develop](#develop)
    16. 

  16. - [License](#license)
    17. 

  17. 

  18. ## Remote control
    19. 

  19. 

  20. This project is use to connect a presentation with the [DeckDeckGo's Progressive Web App](https://deckdeckgo.app) respectively the remote control.   
    21. 

    22. 

  22. The projects where the peers are implemented are the following:
    23. 

  23. 

  24. ### Receiver
    25. 

  25. 

  26. The remote control "receiver" which should be included in the presentation:
    27. 

  27. 

  28. | Source |
    29. 

  29. | -------------------------- |
    30. 

  30. | [https://github.com/deckgo/deckdeckgo-remote](https://github.com/deckgo/deckdeckgo-remote) |
    31. 

  31. 

  32. ### Emitter
    33. 

  33. 

  34. The remote control "emitter", the Progressive Web App, which lets you present and interact with your presentation:
    35. 

  35. 

  36. | Application                      | Source |
    37. 

  37. | -------------------------- |:-----------------:|
    38. 

  38. |[https://deckdeckgo.app](https://deckdeckgo.app)|[https://github.com/deckgo/deckdeckgo-app](https://github.com/deckgo/deckdeckgo-app)|
    39. 

  39. 

  40. ## Poll
    41. 

  41. 

  42. This project also act as a middle point for the live voting when you are interacting with your audience.
    43. 

  43. 

  44. The voting ("where your audience are recording their votes") is implemented in [DeckDeckGo].
    45. 

  45. 

  46. The question and the display of the live results is implemented with a template in your presentation.
    47. 

  47. 

  48. ## Develop
    49. 

  49. 

  50. If you would like to install and run locally this backend, proceed as following:
    51. 

  51. 

  52. ```
    53. 

  53. git clone https://github.com/deckgo/deckdeckgo
    54. 

  54. cd backend
    55. 

  55. npm install
    56. 

  56. npm run start
    57. 

  57. ```
    58. 

  58. 

  59. ## License
    60. 

  60. 

  61. MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com)
    62. 

  62. 

  63. [DeckDeckGo]: https://deckdeckgo.com
    64.