refactor: create a dot-env template file

Author: lpm0073

Makefile

@@ -14,7 +14,7 @@ PIP := $(PYTHON) -m pip
 ifneq ("$(wildcard .env)","")
     include .env
 else
-    $(shell echo -e "OPENAI_API_ORGANIZATION=PLEASE-ADD-ME\nOPENAI_API_KEY=PLEASE-ADD-ME\nPINECONE_API_KEY=PLEASE-ADD-ME\nPINECONE_ENVIRONMENT=gcp-starter\nGOOGLE_MAPS_API_KEY=PLEASE-ADD-ME\nDEBUG_MODE=True\n" >> .env)
+    $(shell cp ./doc/example-dot-env .env)
 endif
 
 .PHONY: analyze pre-commit api-init api-activate api-lint api-clean api-test client-init client-lint client-update client-run client-build client-release

README.md

@@ -23,7 +23,7 @@ A [React](https://react.dev/) + [AWS Serverless](https://aws.amazon.com/serverle
 
 2. Review and edit the master [Terraform configuration](./api/terraform/terraform.tfvars) file **before** running the commands below.
 
-3. Add your API keys and AWS CLI configuration data to a `.env` file which the `make init` command below will automatically scaffold for you. See [this screen shot](https://github.com/FullStackWithLawrence/aws-openai/blob/main/doc/img/dot-env.png) example.
+3. Add your API keys and AWS CLI configuration data to a `.env` file which the `make init` command below will automatically scaffold for you, or if you prefer, you can use this [example-dot-env](https://github.com/FullStackWithLawrence/aws-openai/blob/main/doc/example-dot-env) template to create the file yourself.
 
 4. Initialize, build and run the application
 

doc/example-dot-env

@@ -0,0 +1,20 @@
+# Required environment variables
+# ---------------------------------
+OPENAI_API_KEY=sk-SET-ME-PLEASE
+
+# Optional environment variables
+# ---------------------------------
+AWS_APIGATEWAY_CREATE_CUSTOM_DOMAIN=False
+AWS_APIGATEWAY_ROOT_DOMAIN=example.com
+AWS_PROFILE=default
+AWS_REGION=us-east-1
+AWS_ACCESS_KEY_ID=SET-ME-PLEASE
+AWS_SECRET_ACCESS_KEY=SET-ME-PLEASE
+DEBUG_MODE=False
+DUMP_DEFAULTS=True
+GOOGLE_MAPS_API_KEY=SET-ME-PLEASE
+OPENAI_API_ORGANIZATION=org-SET-ME-PLEASE
+OPENAI_ENDPOINT_IMAGE_N=4
+OPENAI_ENDPOINT_IMAGE_SIZE=1024x768
+PINECONE_API_KEY=SET-ME-PLEASE
+PINECONE_ENVIRONMENT=gcp-starter