Add example

jeremydw · jeremydw · commit d59b878ecec7 · 2020-12-27T11:30:02.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,6 @@
+^build/
 .npmrc
 Makefile
-build/
 dist/
 docs/
 key.json
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@ NOTE: Fileset uses the default App Engine Google Cloud Storage bucket
 (`gs://appid.appspot.com`) to upload files.
 
 1. Within your project, create a directory to house the server files, e.g.
-   `./backend/fileset`. Avoid mixing the server configuration with any tools to
+   `./backend/server`. Avoid mixing the server configuration with any tools to
    build your website. The `package.json`, etc. should be kept separate in order
    to keep the deployment slim.
 
@@ -64,11 +64,17 @@ service: fileset
 runtime: nodejs10
 ```
 
-4. Deploy the app and enable the Cloud Datastore API.
+4. Create the app and deploy.
 
 ```bash
-gcloud app deploy --project=<AppID> app.yaml
-gcloud services enable datastore.googleapis.com --project=<AppID>
+# Create an App Engine app if one doesn't exist yet.
+gcloud app create --project=<AppId>
+
+# Enable the Cloud Datastore API.
+gcloud services enable datastore.googleapis.com --project=<AppId>
+
+# Deploy the app.
+gcloud app deploy --project=<AppId> app.yaml
 ```
 
 ### Deployment setup
@@ -80,9 +86,16 @@ Google Cloud Platform services before and need information on authentication.
 1. Create a `fileset.yaml` configuration file.
 
 ```yaml
-site: siteId  # Specify a site ID. If blank, `default` will be used.
+# Your Google Cloud project's ID (required).
+google_cloud_project: <AppId>
+
+# Your site ID (optional). If blank, `default` will be used.
+site: <SiteId>
+
+# Specify a launch schedule. The schedule maps timestamps to branches or commit
+# shas. If blank, `master` is used for the default deployment.
 schedule:
-  default: master  # Specify a branch for the prod deployment.
+  default: master
 ```
 
 2. Generate your files.
@@ -138,18 +151,18 @@ Build, your project's Cloud Build service account
 To determine your project's project number:
 
 ```bash
-gcloud projects describe <AppID>
+gcloud projects describe <AppId>
 ```
 
 __Application default service account__: When the command is invoked locally
 (i.e. for testing or for manual uploads), you'll likely want to use your App
-Engine app's default service account (`<AppID>@appspot.gserviceaccount.com`).
+Engine app's default service account (`<AppId>@appspot.gserviceaccount.com`).
 You can download a service account key by running:
 
 ```bash
 gcloud iam service-accounts keys create \
   key.json \
-  --iam-account <AppID>@appspot.gserviceaccount.com
+  --iam-account <AppId>@appspot.gserviceaccount.com
 ```
 
 NOTE: This will download a `key.json` to your current directory. Avoid
diff --git a/example/build/index.html b/example/build/index.html
@@ -0,0 +1,5 @@
+<!DOCTYPE html>
+<meta charset="utf-8">
+<title>Hello World</title>
+<h1>Hello World</h1>
+<p>Welcome to my homepage.</p>
diff --git a/example/fileset.yaml b/example/fileset.yaml
@@ -0,0 +1,4 @@
+google_cloud_project: <AppId>
+site: <SiteId>
+schedule:
+  default: master
diff --git a/example/package.json b/example/package.json
@@ -0,0 +1,9 @@
+{
+  "scripts": {
+    "start": "fileset serve",
+    "upload": "fileset upload build"
+  },
+  "devDependencies": {
+    "@blinkk/fileset": "^0.1.0"
+  }
+}
diff --git a/example/server/README.md b/example/server/README.md
@@ -0,0 +1,17 @@
+# Fileset server
+
+This directory contains the configuration files for deploying the Fileset
+server. It only needs to be deployed once.
+
+## Deployment
+
+```bash
+# Create an App Engine app if one doesn't exist yet.
+gcloud app create --project=<AppId>
+
+# Enable the Cloud Datastore API.
+gcloud services enable datastore.googleapis.com --project=<AppId>
+
+# Deploy the app.
+gcloud app deploy --project=<AppId> app.yaml
+```
diff --git a/example/server/app.yaml b/example/server/app.yaml
@@ -0,0 +1,2 @@
+service: fileset
+runtime: nodejs10
diff --git a/example/server/package.json b/example/server/package.json
@@ -0,0 +1,8 @@
+{
+  "scripts": {
+    "start": "fileset serve"
+  },
+  "dependencies": {
+    "@blinkk/fileset": "^0.1.0"
+  }
+}

-Original file line number
+Diff line change
@@ @@ -1,6 +1,6 @@ @@
 +^build/
 .npmrc
 Makefile
 -build/
 dist/
 docs/
 key.json
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+service: fileset`
	`2`	`+runtime: nodejs10`