Add sample config file

adab1ts · Jan 31, 2018 · eb0f844 · eb0f844
1 parent ebe066e
commit eb0f844
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 .serverless
 .env*
 config.*
+!config.*.sample
 tmp
 .coveralls.yml
 

diff --git a/config.json.sample b/config.json.sample
@@ -0,0 +1,20 @@
+{
+  "service_id": "YOUR_SERVICE_ID",
+  "project_id": "YOUR_PROJECT_ID",
+  "credentials_file": "YOUR_ABS_PATH_TO_YOUR_CREDENTIALS_FILE",
+  "transport": {
+    "service": "Gmail",
+    "auth": {
+      "type": "OAuth2",
+      "user": "YOUR_AUTHENTICATED_EMAIL_ADDRESS",
+      "clientId": "YOUR_CLIENT_ID",
+      "clientSecret": "YOUR_CLIENT_SECRET",
+      "refreshToken": "YOUR_REFRESH_TOKEN"
+    }
+  },
+  "envelope": {
+    "sender": "FROM_EMAIL_ADDRESS",
+    "recipient": "TO_EMAIL_ADDRESS",
+    "subject": "EMAIL_SUBJECT"
+  }
+}
diff --git a/serverless.yml b/serverless.yml
@@ -16,6 +16,7 @@ package:
     - node_modules/**
     - .gitignore
     - .git/**
+    - config.json.sample
     - LICENSE
     - README.md