Upgrading to Node 10 and using the dotenv plugin (#50)

* Upgrading to Node 10 and using the dotenv plugin

* Update serverless.yml

* Update package.json

Author: jayair

README.md

@@ -113,10 +113,10 @@ We use Jest to run our tests. You can read more about setting up your tests [her
 
 To add environment variables to your project
 
-1. Rename `env.example` to `env.yml`.
-2. Add environment variables for the various stages to `env.yml`.
-3. Uncomment `environment: ${file(env.yml):${self:provider.stage}}` in the `serverless.yml`.
-4. Make sure to not commit your `env.yml`.
+1. Rename `env.example` to `.env`.
+2. Add environment variables for your local stage to `.env`.
+3. Uncomment `environment:` block in the `serverless.yml` and reference the environment variable as `${env:MY_ENV_VAR}`. Where `MY_ENV_VAR` is added to your `.env` file.
+4. Make sure to not commit your `.env`.
 
 #### Linting
 

env.example

@@ -1,12 +1,8 @@
 # HOW TO USE:
 #
-# 1 Add environment variables for the various stages here
-# 2 Rename this file to env.yml and uncomment it's usage
+# 1 Add environment variables for local development.
+# 2 Rename this file to .env and uncomment it's usage
 #   in the serverless.yml.
 # 3 Make sure to not commit this file.
 
-dev:
-  APP_NAME: serverless-nodejs-starter
-
-prod:
-  APP_NAME: serverless-nodejs
+SAMPLE_ENV_VAR=i-am-an-environment-variable

package-lock.json

@@ -13,7 +13,8 @@
     "url": "https://github.com/AnomalyInnovations/serverless-nodejs-starter.git"
   },
   "devDependencies": {
-    "serverless-bundle": "^1.2.2",
+    "serverless-bundle": "^1.2.5",
+    "serverless-dotenv-plugin": "^2.1.1",
     "serverless-offline": "^5.3.3"
   },
   "dependencies": {}

package.json

@@ -8,18 +8,20 @@ package:
 plugins:
   - serverless-bundle # Package our functions with Webpack
   - serverless-offline
+  - serverless-dotenv-plugin # Load .env as environment variables
 
 provider:
   name: aws
-  runtime: nodejs8.10
+  runtime: nodejs10.x
   stage: dev
   region: us-east-1
   # To load environment variables externally
-  # rename env.example to env.yml and uncomment
+  # rename env.example to .env and uncomment
   # the following line. Also, make sure to not
-  # commit your env.yml.
+  # commit your .env.
   #
-  #environment: ${file(env.yml):${self:provider.stage}}
+  #environment:
+  #  sampleEnvVar: ${env:SAMPLE_ENV_VAR}
 
 functions:
   hello: