{"id":22372362,"url":"https://github.com/kenyipp/realworld-nodejs-example-app-infra","last_synced_at":"2026-02-04T09:33:08.957Z","repository":{"id":259665812,"uuid":"879136583","full_name":"kenyipp/realworld-nodejs-example-app-infra","owner":"kenyipp","description":"The infrastructure code for the Conduit application, built using Amazon CDK","archived":false,"fork":false,"pushed_at":"2024-11-14T06:03:50.000Z","size":145,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2024-12-04T20:49:35.050Z","etag":null,"topics":["aws-cdk","aws-cdk-typescript","conduit","conduit-infra","lambda","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kenyipp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-27T04:46:49.000Z","updated_at":"2024-11-14T06:03:54.000Z","dependencies_parsed_at":"2024-10-27T07:43:58.613Z","dependency_job_id":"ad4fb743-8541-4979-9b02-6419538dd0b1","html_url":"https://github.com/kenyipp/realworld-nodejs-example-app-infra","commit_stats":null,"previous_names":["kenyipp/realworld-nodejs-example-app-infra"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenyipp%2Frealworld-nodejs-example-app-infra","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenyipp%2Frealworld-nodejs-example-app-infra/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenyipp%2Frealworld-nodejs-example-app-infra/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenyipp%2Frealworld-nodejs-example-app-infra/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kenyipp","download_url":"https://codeload.github.com/kenyipp/realworld-nodejs-example-app-infra/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236589564,"owners_count":19173429,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws-cdk","aws-cdk-typescript","conduit","conduit-infra","lambda","typescript"],"created_at":"2024-12-04T20:38:05.418Z","updated_at":"2025-10-15T07:31:05.297Z","avatar_url":"https://github.com/kenyipp.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ![Node.js / Express / Typescript / MySql / Knex Example App](./.github/images/logo.png)\n\n\u003cp align=\"center\"\u003e\nExample Node (Express + Knex) codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the \u003ca href=\"https://github.com/gothinkster/realworld-example-apps\"\u003eRealWorld\u003c/a\u003e API spec.\n\u003c/p\u003e\n\n\u003c!-- The badges section --\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/kenyipp/realworld-nodejs-example-app-infra/actions/workflows/ci.yml\"\u003e\u003cimg src=\"https://github.com/kenyipp/realworld-nodejs-example-app-infra/workflows/Continuous Integration/badge.svg\" alt=\"Actions Status\"\u003e\u003c/a\u003e\n\u003c!-- Snyk.io vulnerabilities badge --\u003e\n\u003ca href=\"https://snyk.io/test/github/kenyipp/realworld-nodejs-example-app-infra\"\u003e\u003cimg src=\"https://snyk.io/test/github/kenyipp/realworld-nodejs-example-app-infra/badge.svg\" alt=\"Known Vulnerabilities\"\u003e\u003c/a\u003e\n\u003c!-- Shields.io license badge --\u003e\n\u003ca href=\"https://github.com/kenyipp/realworld-nodejs-example-app-infra/blob/develop/LICENSE\"\u003e\u003cimg alt=\"License\" src=\"https://img.shields.io/npm/l/downsample\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n   This repository contains the infrastructure code for the \u003ca href=\"https://github.com/kenyipp/realworld-nodejs-example-app\"\u003eConduit Application\u003c/a\u003e, a real-world example application adhering to the \u003ca href=\"https://github.com/gothinkster/realworld-example-apps\"\u003eRealWorld\u003c/a\u003e API spec. It uses \u003ca href=\"https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html\"\u003eAWS CDK\u003c/a\u003e to manage the deployment of foundational components such as S3 buckets, IAM roles, SQS queues, and CI/CD pipelines.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n   \u003ca href=\"#architecture-overview\"\u003eArchitecture Overview\u003c/a\u003e\n   \u003cspan\u003e|\u003c/span\u003e\n   \u003ca href=\"#get-started\"\u003eGet Started\u003c/a\u003e\n   \u003cspan\u003e|\u003c/span\u003e\n   \u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\n   \u003cspan\u003e|\u003c/span\u003e\n   \u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\n\u003c/p\u003e\n\n## Table of Contents\n\n- [Architecture Overview](#architecture-overview)\n- [Get Started](#get-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n  - [Usage](#usage)\n  - [Deployment](#deployment)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Architecture Overview\n\nThe project follows a monorepo structure using Turbo Repo and is divided into two\nrepositories:\n\n- [Realword Node.js Example App Infrastructure](https://github.com/kenyipp/realworld-nodejs-example-app-infra):\n  Contains the infrastructure stacks such as storage, roles, queues, and CI/CD\n  pipelines.\n- [Realword Node.js Example App](https://github.com/kenyipp/realworld-nodejs-example-app):\n  Contains Lambda functions and API Gateway configuration.\n\n### Architecture Diagram\n\n- **S3**: For object storage, used to store artifacts on CodeBuild.\n- **IAM Roles**: For permissions management, roles are created for CodePipeline,\n  CodeBuild, and Lambda functions.\n- **SQS**: For asynchronous messaging between microservices.\n- **CodePipeline**: For CI/CD deployment pipelines.\n- **API Gateway + Lambda**: Defines the serverless microservices (located in the app\n  repo).\n\n## Get Started\n\n### Prerequisites\n\n- **Node.js v14+**: CDK requires Node.js to be installed.\n- **AWS CDK v2**: Install the latest version of the CDK. npm install -g aws-cdk\n- **Yarn**: Use Yarn as the package manager. npm install -g yarn\n\n### Installation\n\n1. Clone the repository:\n\n   ```sh\n   git clone https://github.com/kenyipp/realworld-nodejs-example-app-infra\n   ```\n\n2. Install dependencies:\n\n   ```sh\n   yarn install\n   ```\n\n### Usage\n\n1. Bootstrap the CDK environment (if not already done):\n\n   ```sh\n   cdk bootstrap aws://\u003caccount-id\u003e/\u003cregion\u003e\n   ```\n\n2. Synthesize the CloudFormation templates:\n\n   ```sh\n   cdk synth\n   ```\n\n3. View available stacks:\n\n   ```sh\n   cdk list\n   ```\n\nAfter synthesizing the CDK program, you will see a folder called `cdkgraph` under the\n`cdk.out` folder. You can review the infrastructure to ensure it matches your\nexpectations. Adjust the preset and filter in `main.ts`. For more details on\ngenerating the graph, click [here](#).\n\n### Deployment\n\nWe are using Amazon CDK to deploy the application. Additionally, we have set up a\nCI/CD pipeline to automatically deploy the CDK application once the lint check and\ntest cases pass.\n\n#### Setup Environment Variables\n\n| **Environment Variable**           | **Description**                                                                       | **Example**                        |\n| ---------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------- |\n| `NODE_ENV`                         | The running environment (e.g., development, production)                               | develop, production                |\n| `AWS_ACCOUNT_ID`                   | The AWS account ID. You can get it from the AWS Management Console under \"My Account\" | 123456789012                       |\n| `GITHUB_INFRA_REPOSITORY`          | The repository name of the infrastructure                                             | realworld-nodejs-example-app-infra |\n| `GITHUB_INFRA_OWNER`               | The owner of the infrastructure repository                                            | kenyipp                            |\n| `GITHUB_CONDUIT_SERVER_REPOSITORY` | The repository name of the server                                                     | realworld-nodejs-example-app       |\n| `GITHUB_CONDUIT_SERVER_OWNER`      | The owner of the server repository                                                    | kenyipp                            |\n\nNote: If you want to deploy the application automatically via GitHub Actions, you\nneed to set up the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY in the GitHub\nsettings.\n\n#### Deploy the infrastructure using CDK\n\nTo deploy a specific stack, use:\n\n```sh\ncdk deploy \u003cstack-name\u003e\n```\n\nTo deploy all stacks:\n\n```sh\ncdk deploy --all\n```\n\n## Contributing\n\nPlease review the existing issues in this repository for areas that require\nimprovement. If you identify any missing or potential areas for improvement, feel\nfree to open a new issue.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for\ndetails.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenyipp%2Frealworld-nodejs-example-app-infra","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkenyipp%2Frealworld-nodejs-example-app-infra","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenyipp%2Frealworld-nodejs-example-app-infra/lists"}