init

README.md

@@ -0,0 +1,33 @@
+# Serverless Node.js FullStack starter
+
+## Includes
+
+* Simple React UI hosted with AWS Amplify
+  * Just enough to get you started. This is mostly a blank canvas bootstrapped with Create React App and simple Auth integration with Amplify and Cognito.
+* User authentication with Cognito
+  * Includes auto-verification of Users to reduce friction in signup flow. See instructions below to remove this and force users to verify their email address.
+* Node.js Express API running on Lambda
+* DynamoDB Users table
+  * Upon signing in, a user entry is created in the table if it doesn't yet exist and maps to the user in the Cognito User Pool.
+
+## Getting started
+
+Replace all instances of "myapp" with the name of your application.
+
+Add `myapp_dev` profile to `~/.aws/credentials`. Add `_staging` and `_prod` variants as necessary. It's recommended each developer to have their own account, and for staging and prod to also be deployed to separate accounts.
+
+## Developing
+
+After deploying to your developer AWS account, run `npm run start:api` and `npm run start:ui` separately. Everything except the UI and Lambda Functions use the actual Cloud resources running in your dev account.
+
+## Deploying
+
+Run `sls deploy` to deploy to your dev account. Run `sls deploy --stage staging` or `sls deploy --stage prod` to deploy to staging and prod respectively.
+
+We'll be adding Continuous Deployment soon.
+
+## Customization
+
+## Remove auto-verification
+
+Inside of `serverless.yaml`, remove the `cognitoAutoConfirmUser` function, the `CognitoAutoConfirmUserLambdaCognitoPermission` resource, and the `PreSignUp: !GetAtt CognitoAutoConfirmUserLambdaFunction.Arn` line.