Update template structure to enable grouping functions into separate microservices

Author: cgossain

.gitignore

@@ -1,20 +1,71 @@
-# Binaries for programs and plugins
-*.exe
-*.exe~
-*.dll
-*.so
-*.dylib
-
-# Test binary, built with `go test -c`
-*.test
-
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
-
-# Dependency directories (remove the comment below to include it)
-# vendor/
-
-# Other
-.DS_Store
-node_modules
-.serverless
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser

README.md

@@ -4,48 +4,59 @@ This template project is designed to be used as a starting point for a Google Cl
 
 ## Requirements
 
-- Install [Serverless Framework](https://www.serverless.com/framework/docs/getting-started/)
-- Setup you serverless environment to work with GCP by working you way through the Serverless Framework [GCP guides](https://www.serverless.com/framework/docs/providers/google/guide/intro/)
+- You have the [Serverless Framework](https://www.serverless.com/framework/docs/getting-started/) installed.
+- You have a project already created and configured in Google Cloud. You can follow [this guide](https://www.serverless.com/framework/docs/providers/google/guide/credentials/) to make sure its setup to work with Severless.
+- You've setup your overall environment to work with GCP and the Serverless Framework. You should follow [these guides](https://www.serverless.com/framework/docs/providers/google/guide/intro/) if not.
 
-## Usage
+## Project structure
 
-Create a new service for each logical microservice you intend to deploy.
+The root directory contains a folder for each of your microservices (i.e. Go package).
 
-Each microservice could be made up of a single or several cloud functions.
+The `go.mod` file also resides in the root directory.
 
-### Create a new service
+## Start a new project from the template
 
-Use the `serverless create` command to download the template into a new project folder:
+1. Clone the template repo into a new local project folder:
 
 <pre>
-serverless create --template-url https://github.com/cgossain/serverless-google-cloud-functions-golang-template.git --path <b>mynewservice</b>
+git clone https://github.com/cgossain/serverless-google-cloud-functions-golang-template.git <b>my-gcp-project-name</b>
 </pre>
 
-### Configure the template
-
-1. Navigate to the template directory and install the Google Cloud Functions Provider Plugin:
+2. Update `go.mod` in the root directory with your project name. For example:
 
 <pre>
-cd <b>mynewservice</b> && serverless plugin install --name serverless-google-cloudfunctions
+module github.com/<b>my-gcp-project-name</b>
+
+go 1.13
 </pre>
 
-2. Update `go.mod` with your module name. For example:
+## Create a new micoservice/package
+
+Create a directory (i.e. package) for each logical microservice you intend to deploy. Each microservice could be made up of a single or several cloud functions.
+
+### TL;DR:
+
+1. From the root directory, make a copy of the `templateservice` directory and rename it to match your microservice/package name:
 
 <pre>
-module github.com/<b>my-gcp-project-name</b>/<b>mynewservice</b>
+cp -R templateservice <b>mynewservice</b>
+</pre>
 
-go 1.13
+2. Navigate to the new directory and install the Google Cloud Functions Provider Plugin:
+
+<pre>
+cd <b>mynewservice</b> && serverless plugin install --name serverless-google-cloudfunctions
 </pre>
 
-3. Change the root package name in both `fn.go` adn `fn_test.go` to match you service name:
+3. Update the package name in both `fn.go` and `fn_test.go` to match your microservice/package name:
 
 <pre>
 package <b>mynewservice</b>
 
 ...
 </pre>
 
-4. Open `serverless.yml` and update the configuration (i.e. service name, provider details, etc.):
+4. Open `serverless.yml` and update the configuration (i.e. service name, GCP project name, GCP credentials keyfile, etc.):
 
 <pre>
 service: <b>mynewservice</b>
@@ -54,7 +65,7 @@ provider:
   name: google
   runtime: go113
   project: <b>my-gcp-project-name</b>
-  credentials: ~/.gcloud/keyfile.json # https://www.serverless.com/framework/docs/providers/google/guide/credentials/
+  credentials: <b>~/.gcloud/keyfile.json</b> # https://www.serverless.com/framework/docs/providers/google/guide/credentials/
 
 plugins:
   - serverless-google-cloudfunctions
@@ -73,19 +84,21 @@ functions:
 ...
 </pre>
 
-5. Take a look at [this guide](https://cloud.google.com/functions/docs/writing#structuring_source_code) for ideas on how to structure your source code for different scenarios:
+### Additional info
+
+Take a look at [this guide](https://cloud.google.com/functions/docs/writing#structuring_source_code) for ideas on how to structure your source code for different scenarios:
 
 ## Deploy
 
-Run the following command from your service directory to build and deploy all functions:
+Run the following command from within your microservice/package directory to build and deploy all functions:
 
 <pre>
 cd <b>mynewservice</b> && serverless deploy
 </pre>
 
 ## Remove Deployment
 
-Run the following command from your service directory to remove the deployment of all functions:
+Run the following command from within your microservice/package directory to remove the deployment of all functions:
 
 <pre>
 cd <b>mynewservice</b> && serverless remove

go.mod

@@ -1,3 +1,3 @@
-module github.com/project-m45/gcp-golang/myNewService
+module github.com/my-gcp-project-name
 
 go 1.13

.gcloudignore renamed to templateservice/.gcloudignore

@@ -0,0 +1,20 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Other
+.DS_Store
+node_modules
+.serverless