Merge pull request #3 from serverless/example

Example

Author: eahefnawy

.eslintrc.js

@@ -1,24 +1,18 @@
 module.exports = {
   root: true,
-  extends: [
-    'prettier',
-  ],
-  plugins: [
-    'import',
-    'prettier',
-    'sort-imports-es6-autofix'
-  ],
+  extends: ['prettier'],
+  plugins: ['import', 'prettier', 'sort-imports-es6-autofix'],
   env: {
     es6: true,
     jest: true,
     node: true
   },
   parser: 'babel-eslint',
   parserOptions: {
-    'ecmaVersion': 2018,
-    'sourceType': 'module',
-    'ecmaFeatures': {
-      'jsx': true
+    ecmaVersion: 2018,
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true
     }
   },
   rules: {
@@ -31,12 +25,20 @@ module.exports = {
       }
     ],
     'arrow-parens': ['error', 'always'],
-    'arrow-spacing': ['error', { 'before': true, 'after': true }],
+    'arrow-spacing': ['error', { before: true, after: true }],
     'comma-dangle': ['error', 'never'],
-    'curly': 'error',
+    curly: 'error',
     'eol-last': 'error',
     'func-names': 'off',
-    'id-length': ['error', {'min': 2, 'max': 50, 'properties': 'never', 'exceptions': ['e', 'i', 'n', 't', 'x', 'y', 'z', '_', '$']}],
+    'id-length': [
+      'error',
+      {
+        min: 2,
+        max: 50,
+        properties: 'never',
+        exceptions: ['e', 'i', 'n', 't', 'x', 'y', 'z', '_', '$']
+      }
+    ],
     'no-alert': 'error',
     'no-console': 'error',
     'no-const-assign': 'error',
@@ -51,23 +53,26 @@ module.exports = {
     'object-curly-newline': 'off',
     'object-shorthand': 'off',
     'prefer-const': 'error',
-    'prefer-destructuring': ['error', {'object': true, 'array': false}],
-    'quotes': [
+    'prefer-destructuring': ['error', { object: true, array: false }],
+    quotes: [
       'error',
       'single',
       {
-        'allowTemplateLiterals': true,
-        'avoidEscape': true
+        allowTemplateLiterals: true,
+        avoidEscape: true
       }
     ],
-    'semi': ['error', 'never'],
+    semi: ['error', 'never'],
     'spaced-comment': 'error',
-    'strict': ['error', 'never'],
+    strict: ['error', 'never'],
     'prettier/prettier': 'error',
-    'sort-imports-es6-autofix/sort-imports-es6': ['error', {
-      'ignoreCase': false,
-      'ignoreMemberSort': false,
-      'memberSyntaxSortOrder': ['none', 'all', 'multiple', 'single']
-    }]
+    'sort-imports-es6-autofix/sort-imports-es6': [
+      'error',
+      {
+        ignoreCase: false,
+        ignoreMemberSort: false,
+        memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single']
+      }
+    ]
   }
 }

.npmignore

@@ -79,6 +79,6 @@ CONTRIBUTING.md
 DEVELOPMENT.md
 RELEASE.md
 docs
-examples
+example
 scripts
 src

example/README.md

@@ -0,0 +1,27 @@
+# General
+
+# Architecture
+
+- API Gateway websockets
+- Lambda
+- DynamoDB
+- DynamoDB Streams (just to demo some durability)
+
+# Chat Protocol
+
+### Connect
+
+`wscat -c wss://{ApiId}.execute-api.us-east-1.amazonaws.com/{ApiStage}`
+
+### Messages
+
+`{"action": "sendMessage", "name": "johndoe", "channelId": "General", "content": "hello world!"}`
+
+### Channel Subscriptions
+
+`{"action": "subscribeChannel", "channelId": "Secret"}`
+`{"action": "unsubscribeChannel", "channelId": "Secret"}`
+
+### Get channel history
+
+(coming soon)