Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eric-bach/pecuniary
Pecuniary web application built with AWS CDK
https://github.com/eric-bach/pecuniary
aws cdk dynamodb graphql react serverless
Last synced: about 2 months ago
JSON representation
Pecuniary web application built with AWS CDK
- Host: GitHub
- URL: https://github.com/eric-bach/pecuniary
- Owner: eric-bach
- License: other
- Created: 2019-12-22T20:57:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T15:27:11.000Z (4 months ago)
- Last Synced: 2024-05-22T20:24:01.042Z (4 months ago)
- Topics: aws, cdk, dynamodb, graphql, react, serverless
- Language: TypeScript
- Homepage:
- Size: 9.84 MB
- Stars: 12
- Watchers: 5
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Pecuniary
[](https://github.com/eric-bach/pecuniary/actions/workflows/test.yml)
[](https://github.com/eric-bach/pecuniary/actions/workflows/deploy.yml)
[](https://www.codefactor.io/repository/github/eric-bach/pecuniary)
[](https://github.com/eric-bach/pecuniary/issues?q=is%3Aopen+is%3Aissue) [](https://github.com/eric-bach/pecuniary/issues?q=is%3Aissue+is%3Aclosed)
[](https://gitter.im/pecuniary/community) 
Getting Started |
Architecture |
Development |
Trello |
Resources
An event-driven serverless microservices financial investment application built with Next.js and Tailwind CSS on Amazon Web Services
## Architecture
⚠️Note: the Event Sourcing and CQRS version is no longer maintained. Please see branch and CQRS Architecture for the last release.
## Getting Started
This quick start guide describes how to get the application running. An `AWS account` is required to deploy the infrastructure required for this project.
### Configure the app
1. Clone the project
```bash
$ git clone https://github.com/eric-bach/pecuniary.git
```
2. Install dependencies for CDK
```bash
$ cd ./infrastructure
$ npm install
```
3. Install dependencies for the rest of the application using the recursive-install script
```bash
$ cd ./infrastructure
$ npm cinstall-all
```
4. Copy the `./infrastructure/.env.example` file to `./infrastructure/.env` and fill in the parameter values (if the app has not been deployed to AWS yet, the ARN will be empty for now):
```
DLQ_NOTIFICATIONS - email address to send failed event message notifications to.
```
5. Copy the `./frontend/.env.example` file to `./frontend/.env` and fill in the parameter values from the CDK stack outputs in step 2:
```
NEXT_PUBLIC_USER_POOL_ID=
NEXT_PUBLIC_USER_POOL_CLIENT_ID=
NEXT_PUBLIC_APPSYNC_API_ENDPOINT=
NEXT_PUBLIC_APPSYNC_REGION=
```
## Deploy the app
1. Follow the steps in [Deployment with CDK CLI](#deployment-with-cdk-cli)
## Running the app locally
1. Start the frontend:
```bash
$ cd frontend
$ npm run dev
```
# Deployment
## Deployment with CDK CLI
The Pecuniary application consists of the CDK backend and React frontend, each of which has an independent method of deploying. The backend is deployed via CDK where the frontend is deployed via SST.
### Deploy backend via CDK script
1. Bootstrap CDK (one-time only)
```
$ cdk bootstrap aws://{ACCOUNT_ID}/{REGION} --profile {PROFILE_NAME}}
```
2. Ensure AWS credentials are up to date. If using AWS SSO, authorize a set of temporary credentials
```bash
aws sso login --profile PROFILE_NAME
```
3. Deploy the backend and frontend
```
$ npm run deploy dev PROFILE_NAME
```
## Deployment via GitHub Actions
1. Create an AWS role that can be assumed by GitHub Actions
```
$ npm run deploy-cicd prod PROFILE_NAME
```
2. Add the following GitHub Secrets to the repository
Common
```
CDK_DEFAULT_REGION - AWS default region for all resources to be created
```
Dev environment
```
CLOUDFRONT_DOMAIN_DEV - AWS CloudFront Distribution domain name
COGNITO_USERPOOL_ID_DEV - Cognito User Pool Id
COGNITO_WEB_CLIENT_ID_DEV - Cognito User Pool Client Id
APPSYNC_ENDPOINT_DEV - AWS AppSync GraphQL endpoint URL
CYPRESS_USERNAME - A valid Cognito username for Cypress integration testing
CYPRESS_PASSWORD - The Cognito password for Cypress integration testing
```
Production environment
```
AWS_SERVICE_ROLE_PROD - AWS ARN of the GitHub Actions Role to Assume (from step 1)
CERTIFICATE_ARN - ARN to ACM certificate for CloudFront Distribution
HOSTED_ZONE_ID - Route53 Hosted Zone ID
HOSTED_ZONE_NAME - Route53 Hosted Zone Name
DLQ_NOTIFICATIONS - email address to send DLQ messages to
CLOUDFRONT_DOMAIN_PROD - AWS CloudFront Distribution domain name
COGNITO_USERPOOL_ID_PROD - Cognito User Pool Id
COGNITO_WEB_CLIENT_ID_PROD - Cognito User Pool Client Id
APPSYNC_ENDPOINT_PROD - AWS AppSync GraphQL endpoint URL
```
# Testing
## Jest
To be added
## Cypress
To be added
### Locally
Test the frontend using cypress
```
$ npm run cypress:open
or headless,
$ npm run cypress:run
```
### GitHub Actions
Ensure to configure the GitHub Secrets to include:
```
CYPRESS_USERNAME - A valid Cognito username for Cypress integration testing
CYPRESS_PASSWORD - The Cognito password for Cypress integration testing
```
# Event Sourcing and CQRS Architecture
For more detailed information about the event-driven nature of the Pecuniary application and it's architecture, please see the [Architecture.md](ARCHITECTURE.md)
# Projects References
Links to additional documentation specific to the Application
## AppSync
- [Saved GraphQL queries/mutations for GraphiQl](docs/GraphQL.md)
- [How to add a new GraphQL API/Command Handler](docs/CommandHandler.md)
- [How to call an authenticated AppSync GraphQL API with Apollo Client](docs/ApolloClient.md)
# Resources
Various links to additional articles/tutorials used to build this application.
## AppSync
- [How to build an authenticated GraphQL AppSync API with CDK](https://github.com/dabit3/build-an-authenticated-api-with-cdk)
- [How to perform a GraphQL Query with Apollo using React hooks](https://www.yannisspyrou.com/querying-app-sync-using-react-hooks)
- [How to perform a GraphQL Mutation with Apollo using React hooks](https://www.qualityology.com/tech/connect-to-existing-aws-appsync-api-from-a-react-application/)
## Cognito
- [How to add a protected route to React](https://dev.to/olumidesamuel_/implementing-protected-route-and-authentication-in-react-js-3cl4)
- [How to authenticate with Cognito using React hooks](https://github.com/DevAscend/YT-AWS-Cognito-React-Tutorials)
- [How to add a user to a Cognito User Group](https://bobbyhadz.com/blog/aws-cognito-add-user-to-group)
# License
This project is licensed under the terms of the [MIT license](/LICENSE).