create-aws-project 1.2.1

package/dist/types.d.ts

@@ -0,0 +1,27 @@
+export type Feature = 'github-actions' | 'vscode-config';
+export type BrandColor = 'blue' | 'purple' | 'teal' | 'green' | 'orange';
+export type AuthProvider = 'cognito' | 'auth0' | 'none';
+export type AuthFeature = 'social-login' | 'mfa';
+export interface AuthConfig {
+    provider: AuthProvider;
+    features: AuthFeature[];
+}
+export interface OrgAccountConfig {
+    environment: string;
+    email: string;
+    accountId?: string;
+}
+export interface OrgConfig {
+    enabled: boolean;
+    organizationName: string;
+    accounts: OrgAccountConfig[];
+}
+export interface ProjectConfig {
+    projectName: string;
+    platforms: ('web' | 'mobile' | 'api')[];
+    awsRegion: string;
+    features: Feature[];
+    brandColor: BrandColor;
+    auth: AuthConfig;
+    org?: OrgConfig;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/validation/project-name.d.ts

@@ -0,0 +1 @@
+export declare function validateProjectName(name: string): true | string;

package/dist/validation/project-name.js

@@ -0,0 +1,12 @@
+import validateNpmPackageName from 'validate-npm-package-name';
+export function validateProjectName(name) {
+    if (!name.trim()) {
+        return 'Project name is required';
+    }
+    const validation = validateNpmPackageName(name);
+    if (!validation.validForNewPackages) {
+        const errors = [...(validation.errors || []), ...(validation.warnings || [])];
+        return errors[0] || 'Invalid package name';
+    }
+    return true;
+}

package/dist/wizard.d.ts

@@ -0,0 +1,2 @@
+import type { ProjectConfig } from './types.js';
+export declare function runWizard(): Promise<ProjectConfig | null>;

package/dist/wizard.js

@@ -0,0 +1,81 @@
+import prompts from 'prompts';
+import pc from 'picocolors';
+import { projectNamePrompt } from './prompts/project-name.js';
+import { platformsPrompt } from './prompts/platforms.js';
+import { authProviderPrompt, authFeaturesPrompt } from './prompts/auth.js';
+import { featuresPrompt } from './prompts/features.js';
+import { awsRegionPrompt } from './prompts/aws-config.js';
+import { themePrompt } from './prompts/theme.js';
+import { enableOrgPrompt, orgNamePrompt, orgEnvironmentsPrompt, devEmailPrompt, stageEmailPrompt, prodEmailPrompt, qaEmailPrompt, sandboxEmailPrompt, } from './prompts/org-structure.js';
+export async function runWizard() {
+    const response = await prompts([
+        projectNamePrompt,
+        platformsPrompt,
+        authProviderPrompt,
+        authFeaturesPrompt,
+        featuresPrompt,
+        awsRegionPrompt,
+        enableOrgPrompt,
+        orgNamePrompt,
+        orgEnvironmentsPrompt,
+        devEmailPrompt,
+        stageEmailPrompt,
+        prodEmailPrompt,
+        qaEmailPrompt,
+        sandboxEmailPrompt,
+        themePrompt
+    ], {
+        onCancel: () => {
+            console.log(`\n${pc.red('✖')} Setup cancelled`);
+            process.exit(0);
+        }
+    });
+    // Validate all required fields present
+    if (!response.projectName || !response.platforms?.length || !response.awsRegion || !response.brandColor) {
+        return null;
+    }
+    // features defaults to empty array if all deselected
+    if (!response.features) {
+        response.features = [];
+    }
+    // Construct auth config with defaults
+    const auth = {
+        provider: response.authProvider || 'none',
+        features: response.authFeatures || [],
+    };
+    // Construct org config if enabled
+    let org;
+    if (response.enableOrg) {
+        const accounts = [];
+        const emailMap = {
+            dev: response.devEmail,
+            stage: response.stageEmail,
+            prod: response.prodEmail,
+            qa: response.qaEmail,
+            sandbox: response.sandboxEmail,
+        };
+        for (const env of response.orgEnvironments || []) {
+            const email = emailMap[env];
+            if (email) {
+                accounts.push({ environment: env, email });
+            }
+        }
+        org = {
+            enabled: true,
+            organizationName: response.orgName,
+            accounts,
+        };
+    }
+    const config = {
+        projectName: response.projectName,
+        platforms: response.platforms,
+        awsRegion: response.awsRegion,
+        features: response.features,
+        brandColor: response.brandColor,
+        auth,
+    };
+    if (org) {
+        config.org = org;
+    }
+    return config;
+}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "create-aws-project",
+  "version": "1.2.1",
+  "description": "CLI tool to scaffold AWS projects",
+  "type": "module",
+  "main": "./dist/index.js",
+  "bin": {
+    "create-aws-project": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",
+    "test:coverage": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "prepublishOnly": "npm run build"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md"
+  ],
+  "keywords": [
+    "aws",
+    "starter-kit",
+    "cli",
+    "scaffold",
+    "nx",
+    "monorepo"
+  ],
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wickidcool/create-aws-project.git"
+  },
+  "author": "wickidcool",
+  "homepage": "https://github.com/wickidcool/create-aws-project#readme",
+  "bugs": {
+    "url": "https://github.com/wickidcool/create-aws-project/issues"
+  },
+  "dependencies": {
+    "@aws-sdk/client-iam": "^3.971.0",
+    "@aws-sdk/client-organizations": "^3.700.0",
+    "@aws-sdk/credential-providers": "^3.971.0",
+    "@octokit/rest": "^22.0.1",
+    "picocolors": "^1.1.1",
+    "prompts": "^2.4.2",
+    "tweetnacl": "^1.0.3",
+    "tweetnacl-util": "^0.15.1",
+    "validate-npm-package-name": "^7.0.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.10.1",
+    "@types/prompts": "^2.4.9",
+    "@types/validate-npm-package-name": "^4.0.2",
+    "@typescript-eslint/eslint-plugin": "^8.48.0",
+    "@typescript-eslint/parser": "^8.48.0",
+    "eslint": "^9.39.1",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.5",
+    "typescript": "^5.9.3"
+  }
+}

package/templates/.github/actions/build-and-test/action.yml

@@ -0,0 +1,24 @@
+name: "Build and Test"
+description: "Build the project and run unit tests"
+
+inputs:
+  build-command:
+    description: "Build command to run"
+    required: false
+    default: "npm run build:all"
+  skip-tests:
+    description: "Skip running tests"
+    required: false
+    default: "false"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Build project
+      shell: bash
+      run: ${{ inputs.build-command }}
+
+    - name: Run unit tests
+      if: inputs.skip-tests != 'true'
+      shell: bash
+      run: npm run test

package/templates/.github/actions/deploy-cdk/action.yml

@@ -0,0 +1,46 @@
+name: "Deploy CDK Stacks"
+description: "Configure AWS credentials and deploy CDK stacks"
+
+inputs:
+  aws-access-key-id:
+    description: "AWS Access Key ID"
+    required: true
+  aws-secret-access-key:
+    description: "AWS Secret Access Key"
+    required: true
+  aws-region:
+    description: "AWS Region"
+    required: false
+    default: "us-east-2"
+  environment:
+    description: "Deployment environment (dev, stage, prod)"
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Configure AWS credentials
+      uses: aws-actions/configure-aws-credentials@v5
+      with:
+        aws-access-key-id: ${{ inputs.aws-access-key-id }}
+        aws-secret-access-key: ${{ inputs.aws-secret-access-key }}
+        aws-region: ${{ inputs.aws-region }}
+
+    - name: Clean old CDK assets
+      shell: bash
+      run: |
+        CDK_ASSETS_BUCKET=$(aws s3api list-buckets --query 'Buckets[?contains(Name, `cdk-`) && contains(Name, `-assets-`)].Name' --output text | head -1)
+        if [ -n "$CDK_ASSETS_BUCKET" ]; then
+          echo "Cleaning CDK assets bucket: $CDK_ASSETS_BUCKET"
+          aws s3 rm s3://$CDK_ASSETS_BUCKET/ --recursive
+        else
+          echo "No CDK assets bucket found"
+        fi
+
+    - name: Deploy Main Stack
+      shell: bash
+      run: npm run cdk:deploy -- --require-approval never -c environment=${{ inputs.environment }}
+      env:
+        AWS_ACCESS_KEY_ID: ${{ inputs.aws-access-key-id  }}
+        AWS_SECRET_ACCESS_KEY: ${{ inputs.aws-secret-access-key  }}
+        AWS_REGION: ${{ inputs.aws-region }}

package/templates/.github/actions/deploy-web/action.yml

@@ -0,0 +1,72 @@
+name: "Deploy Web App"
+description: "Build and deploy web app to S3/CloudFront"
+
+inputs:
+  aws-access-key-id:
+    description: "AWS Access Key ID"
+    required: true
+  aws-secret-access-key:
+    description: "AWS Secret Access Key"
+    required: true
+  aws-region:
+    description: "AWS Region"
+    required: false
+    default: "us-east-2"
+  environment:
+    description: "Deployment environment (dev, stage, prod)"
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Configure AWS credentials
+      uses: aws-actions/configure-aws-credentials@v5
+      with:
+        aws-access-key-id: ${{ inputs.aws-access-key-id }}
+        aws-secret-access-key: ${{ inputs.aws-secret-access-key }}
+        aws-region: ${{ inputs.aws-region }}
+
+    - name: Get deployed CloudFront ID and S3 bucket
+      id: get-aws-resources
+      shell: bash
+      run: |
+        ENVIRONMENT="${{ inputs.environment }}"
+
+        # Get S3 bucket name from CloudFormation export
+        S3_BUCKET_NAME=$(aws cloudformation list-exports --query "Exports[?Name=='${ENVIRONMENT}-web-bucket-name'].Value" --output text)
+
+        if [ -z "$S3_BUCKET_NAME" ] || [ "$S3_BUCKET_NAME" == "None" ]; then
+          echo "Error: Could not find web bucket export for environment: ${ENVIRONMENT}"
+          echo "Expected export name: ${ENVIRONMENT}-web-bucket-name"
+          exit 1
+        fi
+
+        echo "S3_BUCKET_NAME=$S3_BUCKET_NAME" >> $GITHUB_OUTPUT
+        echo "S3 Bucket: $S3_BUCKET_NAME"
+
+        # Get CloudFront distribution ID from CloudFormation export
+        CLOUDFRONT_ID=$(aws cloudformation list-exports --query "Exports[?Name=='${ENVIRONMENT}-distribution-id'].Value" --output text)
+
+        if [ -z "$CLOUDFRONT_ID" ] || [ "$CLOUDFRONT_ID" == "None" ]; then
+          echo "Error: Could not find CloudFront distribution export for environment: ${ENVIRONMENT}"
+          echo "Expected export name: ${ENVIRONMENT}-distribution-id"
+          exit 1
+        fi
+
+        echo "CLOUDFRONT_ID=$CLOUDFRONT_ID" >> $GITHUB_OUTPUT
+        echo "CloudFront ID: $CLOUDFRONT_ID"
+
+    - name: Build web app
+      shell: bash
+      run: npm run build:web
+
+    - name: Deploy to S3
+      shell: bash
+      run: aws s3 sync ./dist/apps/web/ s3://${{ steps.get-aws-resources.outputs.S3_BUCKET_NAME }}/ --delete
+
+    - name: Invalidate CloudFront Cache
+      shell: bash
+      run: |
+        aws cloudfront create-invalidation \
+          --distribution-id ${{ steps.get-aws-resources.outputs.CLOUDFRONT_ID }} \
+          --paths "/*"

package/templates/.github/actions/setup/action.yml

@@ -0,0 +1,29 @@
+name: "Setup Node.js Environment"
+description: "Setup Node.js and install dependencies (requires checkout first)"
+
+inputs:
+  node-version:
+    description: "Node.js version to use"
+    required: false
+    default: "22"
+  use-lfs:
+    description: "Whether to checkout LFS objects"
+    required: false
+    default: "false"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Checkout LFS objects
+      if: inputs.use-lfs == 'true'
+      shell: bash
+      run: git lfs checkout
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ inputs.node-version }}
+
+    - name: Install dependencies
+      shell: bash
+      run: npm ci

package/templates/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+<!-- PLEASE READ THE FOLLOWING INSTRUCTIONS -->
+
+### List of features
+Format of information to be provided
+
+**Proof of your testing, video or image link?**
+
+
+### Feature Pull Request Checklist
+
+- [ ] have you rebase your `feature` with `main`?
+- [ ] did you verify the latest commit of `main` exist in your `feature` branch after rebase?
+- [ ] have you tested the `feature` as per the requirement?
+- [ ] did you follow the proper naming conventions in your code?
+- [ ] have you commented your code with proper explanation?

package/templates/.github/workflows/deploy-dev.yml

@@ -0,0 +1,80 @@
+name: Deploy to Dev
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+    inputs:
+      target_branch:
+        description: "The release branch to run the script against"
+        required: true
+        default: "main"
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup environment
+        uses: ./.github/actions/setup
+
+      - name: Run lint
+        shell: bash
+        run: npm run lint
+
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup environment
+        uses: ./.github/actions/setup
+        with:
+          use-lfs: "true"
+
+      - name: Build and test
+        uses: ./.github/actions/build-and-test
+
+  deploy-dev:
+    needs: [validate, test]
+    runs-on: ubuntu-latest
+    name: Deploy to DEV
+    environment: development
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup environment
+        uses: ./.github/actions/setup
+        with:
+          use-lfs: "true"
+
+      - name: Build project
+        uses: ./.github/actions/build-and-test
+        with:
+          skip-tests: "true"
+
+      - name: Deploy to AWS
+        uses: ./.github/actions/deploy-cdk
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          environment: development
+
+      - name: Deploy Web to AWS
+        uses: ./.github/actions/deploy-web
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          environment: development

package/templates/.github/workflows/deploy-prod.yml

@@ -0,0 +1,67 @@
+name: Release to Prod
+
+on:
+  release:
+    types: [released]
+  workflow_dispatch:
+    inputs:
+      target_branch:
+        description: "The release branch to run the script against"
+        required: true
+        default: "main"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.target_branch }}
+          lfs: true
+
+      - name: Setup environment
+        uses: ./.github/actions/setup
+        with:
+          use-lfs: "true"
+
+      - name: Build and test
+        uses: ./.github/actions/build-and-test
+
+  deploy-prod:
+    needs: [test]
+    runs-on: ubuntu-latest
+    name: Deploy to PROD
+    environment: prod
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.target_branch }}
+          lfs: true
+
+      - name: Setup environment
+        uses: ./.github/actions/setup
+        with:
+          use-lfs: "true"
+
+      - name: Build project
+        uses: ./.github/actions/build-and-test
+        with:
+          skip-tests: "true"
+
+      - name: Deploy to AWS
+        uses: ./.github/actions/deploy-cdk
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          environment: prod
+
+      - name: Deploy Web to AWS
+        uses: ./.github/actions/deploy-web
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          environment: prod

package/templates/.github/workflows/deploy-stage.yml

@@ -0,0 +1,77 @@
+name: Pre-Release to Stage
+
+on:
+  release:
+    types: [prereleased]
+  workflow_dispatch:
+    inputs:
+      target_branch:
+        description: "The release branch to run the script against"
+        required: true
+        default: "main"
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.target_branch }}
+          lfs: true
+
+      - name: Setup environment
+        uses: ./.github/actions/setup
+        with:
+          use-lfs: "true"
+
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup environment
+        uses: ./.github/actions/setup
+        with:
+          use-lfs: "true"
+
+      - name: Build and test
+        uses: ./.github/actions/build-and-test
+
+  deploy-stage:
+    needs: [validate, test]
+    runs-on: ubuntu-latest
+    name: Deploy to Stage
+    environment: stage
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup environment
+        uses: ./.github/actions/setup
+
+      - name: Build project
+        uses: ./.github/actions/build-and-test
+        with:
+          build-command: "npm run build:all"
+          skip-tests: "true"
+
+      - name: Deploy to AWS
+        uses: ./.github/actions/deploy-cdk
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          environment: stage
+
+      - name: Deploy Web to AWS
+        uses: ./.github/actions/deploy-web
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          environment: stage

package/templates/.github/workflows/pull-request.yml

@@ -0,0 +1,72 @@
+name: Pull Request Checks
+
+on:
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup environment
+        uses: ./.github/actions/setup
+
+      - name: Run lint
+        shell: bash
+        run: npm run lint
+
+  test:
+    runs-on: ubuntu-latest
+    env:
+      NODE_ENV: dev
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup environment
+        uses: ./.github/actions/setup
+        with:
+          use-lfs: "true"
+
+      - name: Build and test
+        uses: ./.github/actions/build-and-test
+
+      - name: Run tests with coverage
+        run: npm run test:coverage
+        env:
+          NODE_OPTIONS: "--localstorage-file=/tmp/jest-localstorage"
+
+      - name: Coverage Report
+        uses: MishaKav/jest-coverage-comment@main
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          coverage-summary-path: ./coverage/apps/web/coverage-summary.json
+          title: "Test Coverage Report"
+          summary-title: "Coverage Summary"
+          multiple-files: |
+            Web App, ./coverage/apps/web/coverage-summary.json
+            API, ./coverage/apps/api/coverage-summary.json
+            API Client, ./coverage/packages/api-client/coverage-summary.json
+            Mobile, ./coverage/apps/mobile/coverage-summary.json
+
+  build:
+    needs: [lint, test]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup environment
+        uses: ./.github/actions/setup
+
+      - name: Build project
+        uses: ./.github/actions/build-and-test
+        with:
+          skip-tests: "true"