create-wirejs-deploy-amplify-basic 1.0.165 → 1.0.166

package/assets/docs-amplify.md

@@ -0,0 +1,36 @@
+# Amplify Deployment Notes
+
+This document covers important topics specific to AWS Amplify deployments of this app.
+
+## Email Sending (SES)
+
+This app uses `EmailSender` from `wirejs-resources` to send email. Locally, emails are written to the `.outbox` folder in your project root for easy inspection. In Amplify deployments, emails are sent via [AWS Simple Email Service (SES)](https://aws.amazon.com/ses/).
+
+### Verifying Your Sender Address
+
+AWS SES requires that sender email addresses be verified before you can send from them. **During each Amplify deployment, a verification email is automatically sent to any unverified sender address** used in your app. Check your inbox for an email from AWS and click the verification link.
+
+If you need to re-trigger verification manually:
+
+1. Open the [AWS SES Verified Identities console](https://console.aws.amazon.com/ses/home#/verified-identities).
+2. Click **Create identity**.
+3. Select **Email address** and enter the address used in your `EmailSender` constructor.
+4. Click **Create identity** and check your inbox for a verification email.
+5. Click the verification link in the email.
+
+### SES Sandbox Mode
+
+New AWS accounts start in **SES sandbox mode**, which means:
+
+- You can only send email **to** verified addresses.
+- There are daily sending limits.
+
+To send email to unverified recipients (i.e., real users), you must request **production access**:
+
+1. Go to [SES Account Dashboard](https://console.aws.amazon.com/ses/home#/account).
+2. Click **Request production access**.
+3. Fill in the request form and submit.
+
+AWS typically reviews these requests within 24 hours.
+
+For more information, see the [AWS SES documentation](https://docs.aws.amazon.com/ses/latest/dg/request-production-access.html).

package/bin.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+const fs = require('fs');
 const copy = require('recursive-copy');
 
 (async () => {
@@ -7,6 +8,30 @@ const copy = require('recursive-copy');
 	await copy(`${__dirname}/assets/amplify.yml`, `./amplify.yml`);
 	await copy(`${__dirname}/assets/customHttp.yml`, `./customHttp.yml`);
 
+	// Create docs directory and copy Amplify-specific documentation.
+	fs.mkdirSync('./docs', { recursive: true });
+	await copy(`${__dirname}/assets/docs-amplify.md`, `./docs/amplify.md`);
+
+	// Append an Amplify Deployments section to the project README if it exists.
+	const readmePath = './README.md';
+	const amplifySection = `
+## Amplify Deployments
+
+This project is configured for deployment via [AWS Amplify](https://aws.amazon.com/amplify/).
+
+For important Amplify-specific topics — including email sender verification for SES — see [docs/amplify.md](./docs/amplify.md).
+`;
+	if (fs.existsSync(readmePath)) {
+		const existing = fs.readFileSync(readmePath, 'utf8');
+		if (!existing.includes('## Amplify Deployments')) {
+			fs.appendFileSync(readmePath, amplifySection);
+			console.log("Appended Amplify Deployments section to README.md.");
+		}
+	} else {
+		fs.writeFileSync(readmePath, `# My App\n${amplifySection}`);
+		console.log("Created README.md with Amplify Deployments section.");
+	}
+
 	console.log(`
 Amplify configuration written. Your next steps:
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-wirejs-deploy-amplify-basic",
-	"version": "1.0.165",
+	"version": "1.0.166",
 	"description": "Initializes very basic Amplify deployment configuration.",
 	"author": "Jon Wire",
 	"license": "MIT",