Automate workflow better, remove redundant aws-sdk dependencies

Author: amazon-meaisiah

.cfnlintrc

@@ -0,0 +1,3 @@
+templates: ['cloudformation/template.yaml']
+include_checks: ['I']
+#regions: ['ALL_REGIONS']

BUILDING.md

@@ -0,0 +1,59 @@
+# Development guide
+
+Note: this is for advanced users who want to modify the developer portal code itself.
+
+## Getting Started
+
+1. Install each of these if you haven't already:
+
+    - [Git](https://git-scm.com/)
+    - [Node](https://nodejs.org/en/download/) v12 or later
+    - [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html)
+    - [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html)
+    - [CloudFormation Linter](https://github.com/aws-cloudformation/cfn-python-lint)
+
+2. Clone this repo to your local drive.
+
+3. Create a private S3 bucket for putting zipped lambda functions and zipped templates in. Note the bucket name for the next step. (This can be the same one you used during in the initial deployment.)
+
+4. Create a `/dev-portal/deployer.config.js` file. We recommend using the same values you used during the initial deployment.
+
+    - If you're just building this to release it locally and a fresh environment isn't needed, you can just copy `/dev-portal/example-deployer.config.js` and fill it in locally.
+    - If you need to develop in a fresh environment (say, for contributing back to the developer portal or for some more advanced customization), you can customize this further, and you may find `/dev-portal/example-dev-deployer.config.js` as an easier starting point. The fields are the same, just you can switch between deployments far more easily.
+    - You can put this elsewhere and pass `DEPLOYER_CONFIG=/path/to/deployer.config.js` as an environment variable each time you run a task that uses it, in case you would prefer to manage it outside the repo.
+
+5. Run `node run install release`. This will install everything (the `install`), build the static assets for the first time (the `build` part of `release`), and deploy them (the `deploy` part of `release`).
+
+6. Run `node run start` to start the local development server at `http://localhost:3000`. This also fetches the config from the live website so everything's hooked up correctly. (You can do both this and the previous step in one go via `node run install release start`.)
+
+7. If you created the stack for the first time (or changed the `n` from the development `deployer.config.js` example), you'll need to register a new admin account. In the dev portal, register it as an ordinary user, then go into the Cognito user pool generated for it (you can find it by going to the deployed stack in CloudFormation and searching for "CognitoUserPool" in the "Logical ID" column), search for the account in question (by email is easiest), open it, and add it to the admin group (look for `${STACK_NAME}AdminsGroup`).
+
+8. Make changes locally, test them at `http://localhost:3000`, and, when satisfied, run `npm run release` to build and upload the changes to your cloud dev portal.
+
+## npm Scripts
+
+You can run each of these via `node run ${TASK}`, and you can run multiple together like `node run build deploy`. You can pass options via `node run ${TASK} --key=value` as applicable.
+
+### `node run build`
+
+Builds a production-quality build and copies it to the lambda uploader.
+
+### `node run deploy`
+
+Starts a `sam package` and `sam deploy`, and on success does `node run write-config`. Does not build on its own, though.
+
+### `node run reset-assets`
+
+Resets the static assets to what was last committed to Git. Mainly useful when you want to update a development deployment.
+
+### `node run release`
+
+Synonymous with `node run build deploy reset-assets`, as that's a common operation.
+
+### `node run start`
+
+Gets the output from the CFN stack, writes a local version of the config.js file, and starts up the local development server.
+
+## Notes on static assets
+
+The static assets are only re-uploaded on deployment if the previous deployment and the current deployment were provided different `StaticAssetRebuildToken` parameters. The `npm run deploy` script automatically creates a unique `StaticAssetRebuildToken` for you based on the current date.

dev-portal/README.md

@@ -0,0 +1,45 @@
+// 1. Replace your-lambda-artifacts-bucket-name with the name of the bucket you created in step 3
+//    of the dev setup.
+// 2. Then, replace 'custom-prefix-' in siteAssetsBucket and apiAssetsBucket with your name, your
+//    org name, or some other unique identifier.
+//
+// The resulting bucket names must be globally unique.
+module.exports = {
+  // Required, bucket must be pre-made
+  buildAssetsBucket: 'YOUR_LAMBDA_ARTIFACTS_BUCKET_NAME',
+
+  // Required, created by stack
+  stackName: 'dev-portal',
+  siteAssetsBucket: 'CUSTOM_PREFIX-dev-portal-static-assets',
+  apiAssetsBucket: 'CUSTOM_PREFIX-dev-portal-artifacts',
+
+  // Required, turns on cognito hosted sign in/sign up UI
+  cognitoDomainName: 'CUSTOM_PREFIX-auth',
+
+  // Optional values (uncomment and change values if you want to use them)
+
+  // Change the name of the customers table. Useful for multiple stacks. Defaults to
+  // `'DevPortalCustomers'`.
+  // customersTableName: 'CustomPrefixDevPortalCustomers',
+
+  // Change the name of the pre-login accounts table. Useful for multiple stacks. Defaults to
+  // `'DevPortalPreLoginAccounts'`.
+  // preLoginAccountsTableName: 'CustomPrefixDevPortalPreLoginAccounts',
+
+  // Change the name of the pre-login accounts table. Useful for multiple stacks. Defaults to
+  // `'DevPortalFeedback'`.
+  // feedbackTableName: 'CustomPrefixDevPortalFeedback',
+
+  // Set this to overwrite-content if you want to reset your custom content back to the defaults.
+  // Defaults to `''`.
+  // staticAssetRebuildMode: 'overwrite-content', // ONLY SET
+
+  // AWS SAM CLI profile option: optional specific profile from your AWS credential file. Not used
+  // by default.
+  // awsSamCliProfile: 'my-profile',
+
+  // Set this to `true` if you want to enable development mode. It's `false` by default, and unless
+  // you're actively developing on the developer portal itself locally, you should generally leave
+  // it unset as it disables most protections, including CORS.
+  // developmentMode: false,
+}

dev-portal/example-deployer.config.js

@@ -0,0 +1,73 @@
+// It's recommended you track your live deployments here. You can change this
+// any time you want to do a fresh deployment.
+// Live: 0
+const n = 0
+
+module.exports = {
+  // Required, bucket must be pre-made
+  buildAssetsBucket: 'YOUR_LAMBDA_ARTIFACTS_BUCKET_NAME',
+
+  // Required, created by stack
+  stackName: 'dev-portal',
+  siteAssetsBucket: 'CUSTOM_PREFIX-dev-portal-static-assets',
+  apiAssetsBucket: 'CUSTOM_PREFIX-dev-portal-artifacts',
+
+  // Required, turns on cognito hosted sign in/sign up UI
+  cognitoDomainName: `YOUR_NAMESPACE-auth${n}`,
+
+  // Optional, created by stack
+  customersTableName: `DevPortalCustomers${n}`,
+  preLoginAccountsTableName: `DevPortalPreLoginAccounts${n}`,
+  feedbackTableName: `DevPortalFeedback${n}`,
+
+  // optional, created by stack
+  // It's recommended you set this, though, for easier identification later.
+  cognitoIdentityPoolName: `DevPortalIdentityPool${n}`,
+
+  // Always nuke and rebuild
+  staticAssetRebuildMode: 'overwrite-content',
+
+  // AWS SAM CLI profile option: optional specific profile from your AWS credential file. Not used
+  // by default.
+  // awsSamCliProfile: 'my-profile',
+
+  // Set this to `true` if you want to enable development mode. It's `false` by default, and unless
+  // you're actively developing on the developer portal itself locally, you should generally leave
+  // it unset as it disables most protections, including CORS.
+  // developmentMode: false,
+}
+
+module.exports = {
+  // required; bucket must be pre-made
+  buildAssetsBucket: `YOUR_LAMBDA_ARTIFACTS_BUCKET_NAME`,
+
+  // required, created by stack
+  stackName: `YOUR_NAMESPACE-dev-portal${n}`,
+  siteAssetsBucket: `YOUR_NAMESPACE-dev-portal-static-assets${n}`,
+  apiAssetsBucket: `YOUR_NAMESPACE-dev-portal-artifacts${n}`,
+
+  // optional, created by stack
+  cognitoDomainName: `YOUR_NAMESPACE-auth${n}`,
+  customersTableName: `DevPortalCustomers${n}`,
+  preLoginAccountsTableName: `DevPortalPreLoginAccounts${n}`,
+  feedbackTableName: `DevPortalFeedback${n}`,
+
+  // required; Turns on cognito hosted sign in / sign up UI
+  cognitoDomainName: `CUSTOM_PREFIX-auth`,
+
+  // optional, created by stack
+  // It's recommended you set this, though, for easier identification later.
+  cognitoIdentityPoolName: `DevPortalIdentityPool${n}`,
+
+  // AWS SAM CLI profile option: optional specific profile from your AWS credential file. Not used
+  // by default.
+  // awsSamCliProfile: 'my-profile',
+
+  // Always nuke and rebuild
+  staticAssetRebuildMode: 'overwrite-content',
+
+  // Set this to `true` if you want to enable development mode. It's `false` by default, and unless
+  // you're actively developing on the developer portal itself locally, you should generally leave
+  // it unset as it disables most CORS protections.
+  developmentMode: true
+}

dev-portal/example-dev-deployer.config.js

@@ -3,7 +3,6 @@
   "version": "3.0.2",
   "private": true,
   "dependencies": {
-    "aws-sdk": "^2.326.0",
     "chart.js": "^2.7.2",
     "front-matter": "^3.0.0",
     "jwt-decode": "^2.2.0",
@@ -22,15 +21,11 @@
     "yamljs": "^0.3.0"
   },
   "scripts": {
-    "get-dependencies": "npm install; npm run build",
     "start": "react-scripts start",
-    "build": "react-scripts build; rm -rf ../lambdas/static-asset-uploader/build; cp -r ./build ../lambdas/static-asset-uploader",
-    "deploy": "node ./scripts/deploy-stack.js",
-    "write-config": "node ./scripts/write-config.js",
-    "release": "npm run build && npm run deploy",
+    "build": "react-scripts build",
     "test": "react-scripts test",
     "cover": "react-scripts test --coverage",
-    "coverage": "cover",
+    "coverage": "npm run cover",
     "eject": "react-scripts eject"
   },
   "browserslist": [
@@ -45,4 +40,4 @@
     "node-fetch": "^2.3.0",
     "react-scripts": "^3.4.0"
   }
-}
+}