docs: basic auth example (#46)

* docs: basic auth example

example of Basic Authentication

Author: amondnet

.github/workflows/example-express-basic-auth.yml

@@ -0,0 +1,33 @@
+name: example - basic auth
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  basic-auth:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./
+        id: now-deployment-staging
+        if: github.event_name == 'pull_request'
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          zeit-token: ${{ secrets.ZEIT_TOKEN }}
+          now-org-id: ${{ secrets.NOW_ORG_ID }}
+          now-project-id: ${{ secrets.NOW_PROJECT_ID_AUTH }}
+          working-directory: example/express-basic-auth
+      - uses: ./
+        id: now-deployment-production
+        if: github.event_name == 'push'
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          zeit-token: ${{ secrets.ZEIT_TOKEN }}
+          now-org-id: ${{ secrets.NOW_ORG_ID }}
+          now-project-id: ${{ secrets.NOW_PROJECT_ID_AUTH }}
+          now-args: '--prod'
+          working-directory: example/express-basic-auth

README.md

@@ -35,6 +35,10 @@ This action make a ZEIT Now deployment with github actions.
 
 The url of deployment preview.
 
+### `preview-name`
+
+The name of deployment name.
+
 ## Example Usage
 
 ### Disable ZEIT Now for GitHub
@@ -68,7 +72,6 @@ When set to false, `ZEIT Now for GitHub` will not deploy the given project regar
 `now.json` Example:
 ```json
 {
-  "name": "zeit-now-deployment",
   "version": 2,
   "scope": "amond",
   "public": false,
@@ -137,6 +140,15 @@ jobs:
 ```
 
 
-### Agnular Example
+### Angular Example
 
 See [.github/workflow/example-angular.yml](/.github/workflows/example-angular.yml) , 
+
+
+### Basic Auth Example
+
+How to add Basic Authentication to a Now deployment
+
+See [.github/workflow/examole-express-basic-auth.yml](.github/workflow/examole-express-basic-auth.yml)
+
+[https://github.com/amondnet/now-deployment/tree/master/example/angular](Source Code)

example/express-basic-auth/.gitignore

@@ -0,0 +1 @@
+.now

example/express-basic-auth/_static/index.html

@@ -0,0 +1,2 @@
+Working
+Static

example/express-basic-auth/index.js

@@ -0,0 +1,16 @@
+const express = require("express");
+const basicAuth = require("express-basic-auth");
+
+const app = express();
+
+app.use(
+  basicAuth({
+    users: {
+      user: "pass"
+    },
+    challenge: true
+  })
+);
+app.use(express.static(__dirname + '/_static'));
+
+app.listen(4444, () => console.log('Listening on port 4444...'));

example/express-basic-auth/now.json

@@ -0,0 +1,16 @@
+{
+  "version": 2,
+  "public": false,
+  "builds": [
+    {
+      "src": "index.js",
+      "use": "@now/node-server",
+      "config": {
+        "includeFiles": ["_static/**/*.js"]
+      }
+    }
+  ],
+  "routes": [
+    { "src": "/(.*)", "dest": "index.js" }
+  ]
+}