Skip to content
This repository has been archived by the owner on Jun 23, 2021. It is now read-only.

Commit

Permalink
docs: make READMEs consistent (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
jlhood authored and honglu committed Oct 12, 2019
1 parent 850ddf5 commit 6b98360
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 25 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
## realworld-serverless-application ![Build Status](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoidk1hV1NVOVR6WkJSbjdEN3Evc0lDN2t1ZEQ2ZFVuTDV5Q1ZHMDF5NFZBZTBIWVZxbEtIN2w5NGNPRGxkQmpZVzJaQTVaV1I3Mm5tT1FYN1IxYmFGY1hBPSIsIml2UGFyYW1ldGVyU3BlYyI6Ijc2QU1Qc2lUTXY4Ny9Za2EiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)

This project is an adaptation of the [AWS Serverless Application Repository](https://aws.amazon.com/serverless/serverlessrepo/). It's primary objective is to serve as a case study of how to build a production grade service using a combination of serverless technologies and approaches. The project captures key architectural components, code structure, deployment techniques, testing approaches, and operational practices of the AWS Serverless Application Repository - a production-grade AWS service, written in Java and built using serverless technologies. It is comprised of 4 components.
This project is an adaptation of the [AWS Serverless Application Repository](https://aws.amazon.com/serverless/serverlessrepo/). Its primary objective is to serve as a case study of how to build a real world application using a combination of serverless technologies and approaches. The project captures key architectural components, code structure, deployment techniques, testing approaches, and operational practices of the AWS Serverless Application Repository - a production-grade AWS service, written in Java and built using serverless technologies. It is comprised of 4 components.

![Architecture Diagram](./images/architecture_diagram.png)
![Architecture Diagram](https://github.com/awslabs/realworld-serverless-application/raw/master/images/architecture_diagram.png)

To get started, see the [Quickstart](https://github.com/awslabs/aws-serverless-app-repo-reference-implementation/wiki/Quick-Start) guide. For more details, see our documentation in the [Wiki](https://github.com/awslabs/aws-serverless-app-repo-reference-implementation/wiki) section of the GitHub repository.

For more information, here are some project level references:
1. [Overview]()(TODO: blog post link)
1. [Best Practices](https://github.com/awslabs/realworld-serverless-application/wiki/Best-Practices)
To get started, see the [Quick Start](https://github.com/awslabs/realworld-serverless-application/wiki/Quick-Start) guide. For more details, read our [blog post]() (TODO: blog post link) and see our [project wiki](https://github.com/awslabs/realworld-serverless-application/wiki).

## License

Expand Down
3 changes: 2 additions & 1 deletion analytics/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# realworld-serverless-application-analytics

To get started with the full project, follow the [Quick Start](https://github.com/awslabs/realworld-serverless-application/wiki/Quick-Start) guide.
realworld-serverless-application-analytics is the analytics component of a larger project providing business intelligence queries via Amazon Athena for the application. It can be deployed together with the other system components to produce an example serverless application demonstrating real world patterns and best practices for serverless applications.

To get started with the full project, follow the [Quick Start](https://github.com/awslabs/realworld-serverless-application/wiki/Quick-Start) guide.

## License

Expand Down
4 changes: 1 addition & 3 deletions backend/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# realworld-serverless-application-backend
realworld-serverless-application-backend is a backend service built using Amazon API Gateway, AWS Lambda, Amazon DynamoDB and Amazon Cognito. This component is part of the overall project and is meant to be deployed with the [static-website component](./static-website). Follow steps [here](https://github.com/awslabs/realworld-serverless-application/wiki/backend-module) to deploy this component to your AWS account

![Back-end architecture](https://github.com/awslabs/realworld-serverless-application/raw/master/backend/images/back_end_diagram.png)
realworld-serverless-application-backend is the backend component of a larger project providing a REST API for the application. It can be deployed together with the other system components to produce an example serverless application demonstrating real world patterns and best practices for serverless applications.

To get started with the full project, follow the [Quick Start](https://github.com/awslabs/realworld-serverless-application/wiki/Quick-Start) guide.


## License

This project is licensed under the Apache-2.0 License.
15 changes: 4 additions & 11 deletions ops/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
# realworld-serverless-application-ops
realworld-serverless-application-ops is an operational module that includes Amazon CloudWatch alarms and dashboard for the service. This module is part of the project (TODO link)

To get started with the project, see [Quick Start](https://github.com/awslabs/realworld-serverless-application/wiki/Quick-Start)
realworld-serverless-application-ops is the operations (DevOps) component of a larger project providing alarms and dashboards for the application. It can be deployed together with the other system components to produce an example serverless application demonstrating real world patterns and best practices for serverless applications.

Here are some project level references:
1. [Overview]()(TODO: blog post link)
1. [Best Practices](https://github.com/awslabs/realworld-serverless-application/wiki/Best-Practices)
1. [Walkthrough: Serverless Frontend and Backend](https://github.com/awslabs/realworld-serverless-application/wiki/Serverless-Frontend-and-Backend)
To get started with the full project, follow the [Quick Start](https://github.com/awslabs/realworld-serverless-application/wiki/Quick-Start) guide.

There is also a [deep dive](https://github.com/awslabs/realworld-serverless-application/wiki/realworld-serverless-application-ops-module) on realworld-serverless-application-ops module.
## License

## License Summary

This sample code is made available under the Apache 2.0 license. See the LICENSE file.

This project is licensed under the Apache-2.0 License.
12 changes: 9 additions & 3 deletions static-website/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# aws-sar-static-website
# realworld-serverless-application-website

realworld-serverless-application-website is the website component of a larger project providing a web UI for the application. It can be deployed together with the other system components to produce an example serverless application demonstrating real world patterns and best practices for serverless applications.

To get started with the full project, follow the [Quick Start](https://github.com/awslabs/realworld-serverless-application/wiki/Quick-Start) guide.

## License

This project is licensed under the Apache-2.0 License.

0 comments on commit 6b98360

Please sign in to comment.