Skip to content
This repository was archived by the owner on Oct 20, 2021. It is now read-only.

Commit 9e796b5

Browse files
dkundeldkundel
committed
feat: initial commit
0 parents  commit 9e796b5

File tree

176 files changed

+28658
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

176 files changed

+28658
-0
lines changed

‎.editorconfig

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
charset = utf-8
7+
trim_trailing_whitespace = true
8+
insert_final_newline = true
9+
10+
[*.md]
11+
trim_trailing_whitespace = false

‎.env.example

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# These are only useful for developers of the project as they are pulled in through demo.js
2+
3+
SIGNAL_CHEATMODE_API=
4+
SIGNAL_API_URL=
5+
SIGNAL_WEBSITE_URL=
6+
SIGNAL_API_TEST_AUTH_TOKEN=
7+
SIGNAL_API_TEST_REFRESH_TOKEN=
8+
SIGNAL_DEVELOPER_MODE_API=
9+
TWILIO_ACCOUNT_SID=
10+
TWILIO_AUTH_TOKEN=

‎.eslintrc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"parser": "@typescript-eslint/parser",
3+
"extends": [
4+
"eslint:recommended",
5+
"plugin:@typescript-eslint/recommended",
6+
"plugin:prettier/recommended"
7+
],
8+
"plugins": [
9+
"prettier",
10+
"@typescript-eslint",
11+
"jest"
12+
],
13+
"rules": {
14+
"prettier/prettier": "error",
15+
"@typescript-eslint/explicit-module-boundary-types": "off",
16+
"@typescript-eslint/ban-types": "off",
17+
"@typescript-eslint/no-explicit-any": "off",
18+
"@typescript-eslint/ban-ts-comment": "off",
19+
"unicorn/filename-case": "off"
20+
},
21+
"env": {
22+
"node": true,
23+
"jest": true
24+
}
25+
}

‎.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* text=auto
2+
*.js text eol=lf

‎.github/ISSUE_TEMPLATE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!--
2+
Before filing an issue here, please check existing issues and read the troubleshooting guide for common issues:
3+
https://github.com/twilio-labs/plugin-signal2020/blob/main/docs/TROUBLESHOOTING.md
4+
5+
Please utilize the template below to help us resolve your issue.
6+
7+
Note that many issues can be resolved by updating to the latest version:
8+
twilio plugins:remove @twilio-labs/plugin-signal2020
9+
twilio plugins:install @twilio-labs/plugin-signal2020@latest
10+
-->
11+
12+
### Issue Summary
13+
A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug. Please feel free to include screenshots, or screencasts.
14+
15+
### Steps to Reproduce
16+
1. This is the first step
17+
2. This is the second step
18+
3. Further steps, etc.
19+
20+
### Technical details:
21+
Run `twilio signal2020 --diagnostics -o=json` and paste it in here:
22+
```
23+
# paste diagnostics content here
24+
```
25+
26+
### [optional] screenshots:
27+
Please only add this if it does not contain any personal information you are uncomfortable sharing in public.
28+
29+
### [optional] output from your log file.
30+
The log file is located in your temporary directory. In macOS and Linux that's at `$TMPDIR/twilio-signal-dev-mode.log`. In Windows it's going to be at `%Temp%\twilio-signal-dev-mode.log`. You can also find the path as part of the diagnostics output. If you are unsure about this, skip adding it.
31+
32+
**Important** Make sure to not include any personal information or tokens as this is all public!

‎.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
*-debug.log
2+
*-error.log
3+
/.nyc_output
4+
/dist
5+
/tmp
6+
/yarn.lock
7+
node_modules
8+
coverage
9+
.env
10+
.twilio-functions

‎.prettierrc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"trailingComma": "es5",
3+
"tabWidth": 2,
4+
"semi": true,
5+
"singleQuote": true,
6+
"parser": "typescript"
7+
}

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Twilio Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
<p align="center"><img src="assets/signal-developer-mode-header.png" alt=""></p>
2+
<h1 align="center">SIGNAL Developer Mode</h1>
3+
<p align="center"><a href="https://github.com/twilio-labs/about"><img src="https://img.shields.io/static/v1?label=&message=Twilio-Labs&color=F22F46&labelColor=0D122B&logo=twilio&style=for-the-badge" alt="Part of Twilio Labs Banner"></a></p>
4+
5+
[SIGNAL Developer Mode](https://twil.io/signal-developer-mode) is an augmentation for your experience at Twilio's [SIGNAL 2020 Conference](https://signal.twilio.com).
6+
7+
It's built on top of the [Twilio CLI](https://twil.io/cli) and provides functionality inside your terminal such as:
8+
* __augmented keynote experience__: displaying useful resources, demos and closed-captions as you are watching the keynote
9+
* __access to your full SIGNAL schedule__: view the entire SIGNAL and [SIGNAL TV](https://twitch.tv/twilio) schedule and register for any sessions you are interested in
10+
* __a packed demo section__: explore code samples for a variety of Twilio use-cases and get started in minutes
11+
* __a hidden cheat mode__: find the hidden cheat mode and use it during the keynote session
12+
* and more
13+
14+
### __Table of Contents__
15+
16+
<!-- toc -->
17+
* [Requirements](#requirements)
18+
* [Installation](#installation)
19+
* [Commands](#commands)
20+
* [Contributing](#contributing)
21+
* [License](#license)
22+
<!-- tocstop -->
23+
# Requirements
24+
25+
## Setup
26+
27+
You'll need the [Twilio CLI](https://twil.io/cli) to run SIGNAL Developer Mode. Head over to the [Twilio CLI documentation](https://www.twilio.com/docs/twilio-cli/quickstart) to install it.
28+
29+
Additionally, you'll need a ticket to SIGNAL 2020. Register for a free ticket on the [SIGNAL website](https://signal.twilio.com).
30+
31+
## Supported Terminals
32+
33+
SIGNAL Developer Mode should work in any terminal but some terminals might have limited functionality or [display flickering](https://github.com/vadimdemedes/ink/issues/359).
34+
35+
Some of the terminals that we found that were doing a good job are: [Hyper](https://hyper.is), the built-in macOS Terminal.app and [cmder](https://cmder.net/) on Windows.
36+
37+
For terminals that have known flickering issues we try to detect that and reduce the amount of animations and screen updates. For more info on this check out the [Troubleshooting Guide](docs/TROUBLESHOOTING.md).
38+
39+
SIGNAL Developer Mode will also adapt based on the size of your terminal, however, the bigger your terminal window the better. Alternatively, you can change your terminal font size.
40+
41+
# Installation
42+
43+
```sh-session
44+
$ twilio plugins:install @twilio-labs/plugin-signal2020
45+
$ twilio --help signal2020
46+
USAGE
47+
$ twilio signal2020
48+
...
49+
```
50+
51+
You'll be prompted for your SIGNAL credentials that you also use to [log into the SIGNAL 2020 website](https://signal.twilio.com/login).
52+
53+
> If you don't want to enter your email and password every time, you can also [store them as environment variables](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html) and pass them via the `--email` and `--password` flags to `twilio signal2020`..
54+
55+
## Usage
56+
57+
SIGNAL Developer Mode relies on your keyboard for navigation. Check out the [announcement blog post](https://twil.io/signal-developer-mode) for a detaild walkthrough but here are some common controls:
58+
* <kbd>Ctrl</kbd>+<kbd>C</kbd> will always exit the application
59+
* <kbd>Ctrl</kbd>+<kbd>B</kbd> will toggle the sidebar
60+
* <kbd>&uarr;</kbd> and <kbd>&darr;</kbd> can scroll through lists
61+
* <kbd>&larr;</kbd>, <kbd>&rarr;</kbd>, <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> will cycle through different options
62+
* <kbd>Return</kbd>/<kbd>Enter</kbd> and <kbd>Space</kbd> can toggle actions
63+
* <kbd>Ctrl</kbd>+<kbd>D</kbd> exits the Installer and Cheat Mode
64+
* <kbd>W</kbd>, <kbd>K</kbd>, <kbd>S</kbd>, <kbd>D</kbd>, <kbd>R</kbd> let you switch between different modes (see sidebar inside the Developer Mode for more)
65+
66+
67+
# Commands
68+
<!-- commands -->
69+
* [`twilio signal2020`](#twilio-signal2020)
70+
71+
## `twilio signal2020`
72+
73+
```
74+
USAGE
75+
$ twilio signal2020
76+
77+
OPTIONS
78+
-d, --diagnostics Using this flag will output diagnostics information that will be useful when
79+
debugging issues.
80+
81+
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
82+
83+
-o=(columns|json|tsv) [default: columns] Format of command output.
84+
85+
-p, --profile=profile Shorthand identifier for your profile.
86+
87+
--email=email The email you use to log into signal.twilio.com/login
88+
89+
--feedback Learn how you can give feedback on SIGNAL Developer Mode.
90+
91+
--password=password The password you use to log into signal.twilio.com/login
92+
93+
--tail
94+
95+
ALIASES
96+
$ twilio signal
97+
```
98+
99+
_See code: [dist/commands/signal2020.ts](https://github.com/twilio-labs/plugin-signal2020/blob/v1.0.0-rc.13/dist/commands/signal2020.ts)_
100+
<!-- commandsstop -->
101+
# Contributing
102+
103+
This project welcomes contributions from the community. Please see the [`CONTRIBUTING.md`](docs/CONTRIBUTING.md) file for more details.
104+
105+
## Code of Conduct
106+
107+
Please be aware that this project has a [Code of Conduct](https://github.com/twilio-labs/.github/blob/master/CODE_OF_CONDUCT.md). The tldr; is to just be excellent to each other ❤️
108+
109+
# License
110+
111+
MIT

‎api/.gitignore

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
9+
# Diagnostic reports (https://nodejs.org/api/report.html)
10+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11+
12+
# Runtime data
13+
pids
14+
*.pid
15+
*.seed
16+
*.pid.lock
17+
18+
# Directory for instrumented libs generated by jscoverage/JSCover
19+
lib-cov
20+
21+
# Coverage directory used by tools like istanbul
22+
coverage
23+
*.lcov
24+
25+
# nyc test coverage
26+
.nyc_output
27+
28+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29+
.grunt
30+
31+
# Bower dependency directory (https://bower.io/)
32+
bower_components
33+
34+
# node-waf configuration
35+
.lock-wscript
36+
37+
# Compiled binary addons (https://nodejs.org/api/addons.html)
38+
build/Release
39+
40+
# Dependency directories
41+
node_modules/
42+
jspm_packages/
43+
44+
# Snowpack dependency directory (https://snowpack.dev/)
45+
web_modules/
46+
47+
# TypeScript cache
48+
*.tsbuildinfo
49+
50+
# Optional npm cache directory
51+
.npm
52+
53+
# Optional eslint cache
54+
.eslintcache
55+
56+
# Microbundle cache
57+
.rpt2_cache/
58+
.rts2_cache_cjs/
59+
.rts2_cache_es/
60+
.rts2_cache_umd/
61+
62+
# Optional REPL history
63+
.node_repl_history
64+
65+
# Output of 'npm pack'
66+
*.tgz
67+
68+
# Yarn Integrity file
69+
.yarn-integrity
70+
71+
# dotenv environment variables file
72+
.env
73+
.env.test
74+
75+
# parcel-bundler cache (https://parceljs.org/)
76+
.cache
77+
.parcel-cache
78+
79+
# Next.js build output
80+
.next
81+
out
82+
83+
# Nuxt.js build / generate output
84+
.nuxt
85+
dist
86+
87+
# Gatsby files
88+
.cache/
89+
# Comment in the public line in if your project uses Gatsby and not Next.js
90+
# https://nextjs.org/blog/next-9-1#public-directory-support
91+
# public
92+
93+
# vuepress build output
94+
.vuepress/dist
95+
96+
# Serverless directories
97+
.serverless/
98+
99+
# FuseBox cache
100+
.fusebox/
101+
102+
# DynamoDB Local files
103+
.dynamodb/
104+
105+
# TernJS port file
106+
.tern-port
107+
108+
# Stores VSCode versions used for testing VSCode extensions
109+
.vscode-test
110+
111+
# yarn v2
112+
.yarn/cache
113+
.yarn/unplugged
114+
.yarn/build-state.yml
115+
.yarn/install-state.gz
116+
.pnp.*

‎api/.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
10

‎api/assets/closedCaptioningExample.vtt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
WEBVTT
2+
3+
00:00:00.000 --> 01:00:00.830 align:middle line:90%
4+
Please refresh your app
5+
for the real subtitles

0 commit comments

Comments
 (0)