forked from deckgo/deckdeckgo
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add version and license badges to all readme files
- Loading branch information
1 parent
1231e8f
commit cbcde35
Showing
43 changed files
with
380 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/deckgo/deckdeckgo/blob/master/backend/LICENSE) | ||
|
||
# DeckDeckGo - Backend | ||
|
||
This project is a backend for [DeckDeckGo]. | ||
|
@@ -9,33 +11,33 @@ It also transmits the information for the live voting when you are interacting w | |
## Table of contents | ||
|
||
- [Remote control](#remote-control) | ||
- [Receiver](#receiver) | ||
- [Emitter](#emitter) | ||
- [Receiver](#receiver) | ||
- [Emitter](#emitter) | ||
- [Poll](#poll) | ||
- [Develop](#develop) | ||
- [License](#license) | ||
|
||
## Remote control | ||
|
||
This project is use to connect a presentation with the [DeckDeckGo's Progressive Web App](https://deckdeckgo.app) respectively the remote control. | ||
This project is use to connect a presentation with the [DeckDeckGo's Progressive Web App](https://deckdeckgo.app) respectively the remote control. | ||
|
||
The projects where the peers are implemented are the following: | ||
|
||
### Receiver | ||
|
||
The remote control "receiver" which should be included in the presentation: | ||
|
||
| Source | | ||
| -------------------------- | | ||
| Source | | ||
| ------------------------------------------------------------------------------------------ | | ||
| [https://github.com/deckgo/deckdeckgo-remote](https://github.com/deckgo/deckdeckgo-remote) | | ||
|
||
### Emitter | ||
|
||
The remote control "emitter", the Progressive Web App, which lets you present and interact with your presentation: | ||
|
||
| Application | Source | | ||
| -------------------------- |:-----------------:| | ||
|[https://deckdeckgo.app](https://deckdeckgo.app)|[https://github.com/deckgo/deckdeckgo-app](https://github.com/deckgo/deckdeckgo-app)| | ||
| Application | Source | | ||
| ------------------------------------------------ | :----------------------------------------------------------------------------------: | | ||
| [https://deckdeckgo.app](https://deckdeckgo.app) | [https://github.com/deckgo/deckdeckgo-app](https://github.com/deckgo/deckdeckgo-app) | | ||
|
||
## Poll | ||
|
||
|
@@ -60,4 +62,4 @@ npm run start | |
|
||
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]) | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
[![npm][npm-badge]][npm-badge-url] | ||
[![license][npm-license]][npm-license-url] | ||
|
||
[npm-badge]: https://img.shields.io/npm/v/create-deckdeckgo | ||
[npm-badge-url]: https://www.npmjs.com/package/create-deckdeckgo | ||
[npm-license]: https://img.shields.io/npm/l/create-deckdeckgo | ||
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/cli/LICENSE | ||
|
||
# DeckDeckGo - CLI | ||
|
||
This project is the CLI of [DeckDeckGo]. | ||
|
@@ -12,4 +20,4 @@ This CLI reuse many features of the [Stencil CLI](https://github.com/ionic-team/ | |
|
||
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]) | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/deckgo/deckdeckgo/blob/master/docs/LICENSE) | ||
|
||
# DeckDeckGo - Docs | ||
|
||
This project is the documentation for developer of [DeckDeckGo]. | ||
|
@@ -25,10 +27,10 @@ npm run start | |
|
||
The documentation is written in markdown and the app itself is developed with the [Ionic PWA Toolkit](https://ionicframework.com/pwa/toolkit). | ||
|
||
Before building the application, the markdown content is going to be parsed to HTML and injected in its source code (TSX). | ||
Before building the application, the markdown content is going to be parsed to HTML and injected in its source code (TSX). | ||
|
||
## License | ||
|
||
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]) | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,8 @@ | ||
[![license][agpl-license]][agpl-license-url] | ||
|
||
[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg | ||
[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/infra/GNU-AGPL-3.0 | ||
|
||
# DeckDeckGo - Infrastructure | ||
|
||
This project is the infrastructure of [DeckDeckGo]. | ||
|
@@ -15,7 +20,7 @@ The infrastructure is deployed with [Terraform] and runs on [AWS Lambda]. | |
|
||
To (re)deploy the infrastructure, run the following commands: | ||
|
||
``` shell | ||
```shell | ||
$ cd infra/ | ||
$ nix-shell | ||
$ terraform apply | ||
|
@@ -32,7 +37,7 @@ This project, respectively the infrastructure of [DeckDeckGo], is released under | |
|
||
[DeckDeckGo] is developed by [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]). | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[Terraform]: https://www.terraform.io/ | ||
[AWS Lambda]: https://aws.amazon.com/lambda/ | ||
[Nix]: https://nixos.org/nix/ | ||
[deckdeckgo]: https://deckdeckgo.com | ||
[terraform]: https://www.terraform.io/ | ||
[aws lambda]: https://aws.amazon.com/lambda/ | ||
[nix]: https://nixos.org/nix/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,8 @@ | ||
[![license][agpl-license]][agpl-license-url] | ||
|
||
[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg | ||
[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/infra/handler/GNU-AGPL-3.0 | ||
|
||
# DeckDeckGo - Handler | ||
|
||
This project is the request handler of [DeckDeckGo]. | ||
|
@@ -17,4 +22,4 @@ details. | |
Busco](mailto:[email protected]) and [Nicolas | ||
Mattia](mailto:[email protected]). | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,8 @@ | ||
[![license][agpl-license]][agpl-license-url] | ||
|
||
[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg | ||
[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/remote/GNU-AGPL-3.0 | ||
|
||
# DeckDeckGo - App | ||
|
||
This project is the remote control of [DeckDeckGo] which let you interact with and present your PWA presentation. | ||
|
@@ -16,7 +21,7 @@ Better than a description, the [DeckDeckGo] website implement a deck and receive | |
|
||
1. Open the [DeckDeckGo] website 👉 [https://deckdeckgo.com](https://deckdeckgo.com) | ||
2. Start this Progressive Web App 👉 [https://deckdeckgo.app](https://deckdeckgo.app) | ||
3. Have fun 🎉 | ||
3. Have fun 🎉 | ||
|
||
## Getting Started | ||
|
||
|
@@ -35,4 +40,4 @@ This application, respectively this remote control of [DeckDeckGo], is released | |
|
||
[DeckDeckGo] is developed by [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]). | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,8 @@ | ||
[![license][agpl-license]][agpl-license-url] | ||
|
||
[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg | ||
[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/studio/GNU-AGPL-3.0 | ||
|
||
# DeckDeckGo - Studio | ||
|
||
This project is the editor of [DeckDeckGo]. | ||
|
@@ -17,11 +22,11 @@ cd deckdeckgo/studio | |
npm install | ||
npm run start | ||
``` | ||
|
||
## License | ||
|
||
This application, respectively this editor of [DeckDeckGo] known as "DeckDeckGo Studio", is released under the GNU Affero General Public License. Copyright [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]), Zürich, Switzerland. See COPYING for more details. | ||
|
||
[DeckDeckGo] is developed by [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]). | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
[![npm][npm-badge]][npm-badge-url] | ||
[![license][npm-license]][npm-license-url] | ||
|
||
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/deck-utils | ||
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/deck-utils | ||
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/deck-utils | ||
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/deck/LICENSE | ||
|
||
# DeckDeckGo - Deck utils | ||
|
||
Utils and styles for the [DeckDeckGo] applications. | ||
|
@@ -22,4 +30,4 @@ npm run build | |
|
||
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]) | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
[![npm][npm-badge]][npm-badge-url] | ||
[![license][npm-license]][npm-license-url] | ||
|
||
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-utils | ||
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-utils | ||
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-utils | ||
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/slide/LICENSE | ||
|
||
# DeckDeckGo - Slide utils | ||
|
||
Utils and interfaces for the [DeckDeckGo] slide templates. | ||
|
@@ -22,4 +30,4 @@ npm run build | |
|
||
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]) | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
[![npm][npm-badge]][npm-badge-url] | ||
[![license][npm-license]][npm-license-url] | ||
|
||
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/types-utils | ||
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/types-utils | ||
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/types-utils | ||
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/types/LICENSE | ||
|
||
# DeckDeckGo - Types | ||
|
||
This project defines the events, interfaces and enumerations used for the [WebRTC](https://webrtc.org) real-time communication between the [DeckDeckGo]'s deck and remote control. | ||
|
@@ -22,4 +30,4 @@ npm run build | |
|
||
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]) | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
[![npm][npm-badge]][npm-badge-url] | ||
[![license][npm-license]][npm-license-url] | ||
|
||
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/utils | ||
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/utils | ||
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/utils | ||
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/utils/LICENSE | ||
|
||
# DeckDeckGo - Types | ||
|
||
A collection of utils methods and functions developed and used across apps and components of [DeckDeckGo]. | ||
|
@@ -61,10 +69,10 @@ Compare the `window.innerHeight` and `screen.height` to detect full screen or no | |
|
||
``` | ||
static isFullscreen(): boolean | ||
``` | ||
``` | ||
|
||
## License | ||
|
||
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]) | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
[![npm][npm-badge]][npm-badge-url] | ||
[![license][npm-license]][npm-license-url] | ||
|
||
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/charts | ||
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/charts | ||
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/charts | ||
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/charts/LICENSE | ||
|
||
# DeckDeckGo - Charts | ||
|
||
This component is the charts' plotter of [DeckDeckGo]. | ||
|
@@ -29,4 +37,4 @@ npm run start | |
|
||
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]) | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
[![npm][npm-badge]][npm-badge-url] | ||
[![license][npm-license]][npm-license-url] | ||
|
||
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/color | ||
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/color | ||
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/color | ||
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/color/LICENSE | ||
|
||
# DeckDeckGo - Color Picker | ||
|
||
The "Color Picker" component is a simple component to, guess what, allow your users to "pick colors" 😉 | ||
|
@@ -29,4 +37,4 @@ npm run start | |
|
||
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]) | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
[![npm][npm-badge]][npm-badge-url] | ||
[![license][npm-license]][npm-license-url] | ||
|
||
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/core | ||
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/core | ||
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/core | ||
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/core/LICENSE | ||
|
||
# DeckDeckGo - Core | ||
|
||
This component is the core of [DeckDeckGo]. | ||
|
@@ -24,4 +32,4 @@ npm run start | |
|
||
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]) | ||
|
||
[DeckDeckGo]: https://deckdeckgo.com | ||
[deckdeckgo]: https://deckdeckgo.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.