NX plugin for AWS - @aws/nx-plugin

Quickly bootstrap and build AWS projects easily

👉 See full documentation on https://awslabs.github.io/nx-plugin-for-aws 👈

Intro

@aws/nx-plugin is a collection of generators to help you build cloud-native applications with AWS.

Key Features

• Declarative: Generate code that follows best practices for AWS cloud development.
• Component-Based: Add components to your project as needed, from React websites to serverless APIs using either the CLI or UI.
• Learn Once, Use Anywhere: Consistent patterns across different AWS services and application types.
• Open for modification: All code generated is your code and can be edited as you see fit.
• Type safety: Type-safety is employed to support IDE completions and reduce the number of runtime errors encountered.
• Minimal dependencies: Getting up and running is simple and only requires langugage level global dependencies.

Available Generators

• ts#project - Generate a new TypeScript library.
• ts#infra - Generate a Typescript AWS CDK infrastructure project for your application.
• ts#cloudscape-website - Generate a new Cloudscape/React/Vite based web application.
• ts#cloudscape-website#auth - Add AWS Cognito authentication to your Cloudscape website.
• ts#trpc-api - Generate a tRPC backend service with Amazon API Gateway/AWS Lambda integration and AWS Powertools pre-configured.
• py#project - Generate a uv based Python project.
• py#fast-api - Generate a FastAPI backend service with AWS Powertools pre-configured.
• api-connection - Connect frontend applications to backend APIs.
• license - Automatically manage LICENSE files and source code headers in your workspace.

Getting started

@aws/nx-plugin has been designed for gradual adoption from the start, and you can use as little or as much of it as you need.

1. Create a new NX workspace

npx create-nx-workspace@~20.6.3 demo --pm=pnpm --preset=ts --ci=skip --formatter=prettier
cd demo

2. Install the @aws/nx-plugin

pnpm add -Dw @aws/nx-plugin

3. Add components:

# Generate a tRPC API backend
pnpm nx g @aws/nx-plugin:ts#trpc-api

# Generate a Cloudscape website
pnpm nx g @aws/nx-plugin:ts#cloudscape-website

# Connect the frontend to the backend
pnpm nx g @aws/nx-plugin:api-connection

# Add authentication to your website
pnpm nx g @aws/nx-plugin:ts#cloudscape-website#auth

# Generate AWS CDK infrastructure
pnpm nx g @aws/nx-plugin:ts#infra

Additional resources

• Use Quick Start to get a taste of @aws/nx-plugin.
• Build a Dungeon Adventure Game to get an in-depth guided tutorial on how to use the @aws/nx-plugin.
• Add @aws/nx-plugin to your existing project

Contributing

The main purpose of this repository is to continue evolving @aws/nx-plugin, making it faster and easier to use. Development happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements.

Read our Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to @aws/nx-plugin.

Code of Conduct

This project has adopted a Code of Conduct that we expect project participants to adhere to. Please read the Code of Conduct so that you can understand what actions will and will not be tolerated.

License

@aws/nx-plugin is Apache 2.0 licensed.