Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 16 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ A serverless, progressive, responsive starter user interface (UI) with React at
 
[![Code Quality](https://github.com/leanstacks/react-starter/actions/workflows/code-quality.yml/badge.svg)](https://github.com/leanstacks/react-starter/actions/workflows/code-quality.yml)

## License

This project is licensed under the MIT License - see [LICENSE](./LICENSE) file for details.

## Documentation

For detailed guides and reference materials, see the [Project Documentation](docs/README.md).

## Helpful Hints

### Viewing the Starter Kit
Expand All @@ -29,7 +37,7 @@ When using the application, you may sign in with any of the JSON Placeholder [Us

This project was bootstrapped with the [Vite](https://vitejs.dev/) React TypeScript template.

The production technology stack includes:
The application production technology stack includes:

- React - core web user interface library
- React Router Dom - declarative component routing
Expand All @@ -47,7 +55,7 @@ The production technology stack includes:
- TanStack Table - advanced tables and datagrids
- Recharts - composable charting library for React

The development technology stack includes:
The application development technology stack includes:

- Vite - front end build tooling
- Vitest - core unit test framework
Expand All @@ -56,6 +64,12 @@ The development technology stack includes:
- Storybook - UI component visualization and documentation
- TypeScript - the TypeScript language

The infrastructure technology stack includes:

- AWS CDK - framework for provisioning AWS cloud infrastructure
- Zod - schema based validation
- Jest: unit test framework

### Repository

This repository uses [trunk-based development](https://www.atlassian.com/continuous-delivery/continuous-integration/trunk-based-development). The latest code is located on the `main` branch. The `main` branch is always ready for deployment.
Expand Down Expand Up @@ -240,31 +254,6 @@ Starts the [Storybook][storybook] UI. Open [http://localhost:6006](http://localh

Build a static version the [Storybook][storybook] UI which may be deployed to a CDN or HTTP server.

## DevOps

### Cloud Resources

The AWS resources for this application component are provisioned via the AWS Cloud Development Kit (CDK) Infrastructure as Code (IaC) written in TypeScript. The AWS CDK logic and dependencies are organized as a self-contained Node.js application located in the `/infrastructure` directory.

The AWS resources provisioned to host the React app are:

| Resource | Description |
| ----------------------- | --------------------------------------------------- |
| S3 Bucket | Contains the static assets for the application. |
| CloudFront Distribution | A CloudFront distribution to serve the application. |
| Route53 RecordSet | An `A` record for the CloudFront distribution. |
| Route53 RecordSet | An `AAAA` record for the CloudFront distribution. |

> **NOTE:** A similar set of AWS resources may optionally be provisioned to host the Storybook application.

## Documentation

For detailed guides and reference materials, see the [Project Documentation](docs/README.md).

## License

This project is licensed under the MIT License - see [LICENSE](./LICENSE) file for details.

## Further Reading

- [Project Documentation](./docs/README.md)
Expand Down
Loading