{"id":17287698,"url":"https://github.com/hxtree/galaxyops","last_synced_at":"2025-04-13T15:34:50.100Z","repository":{"id":42510572,"uuid":"438855397","full_name":"hxtree/galaxyops","owner":"hxtree","description":"DevOps Architecture for AWS Workloads","archived":false,"fork":false,"pushed_at":"2025-02-19T14:58:07.000Z","size":416893,"stargazers_count":12,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-04T00:36:16.514Z","etag":null,"topics":["aws-cdk-v2","co-op","cqrs-pattern","devops","event-driven","monorepo","nestjs","nx","platform-engineering","reactjs","rpg-game","serverless","typescript"],"latest_commit_sha":null,"homepage":"https://design.sandbox.nekosgate.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hxtree.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-16T04:06:13.000Z","updated_at":"2025-02-19T14:58:09.000Z","dependencies_parsed_at":"2023-10-15T00:27:54.865Z","dependency_job_id":"cb45cdd7-238d-463b-9078-f322008b6076","html_url":"https://github.com/hxtree/galaxyops","commit_stats":{"total_commits":1214,"total_committers":8,"mean_commits":151.75,"dds":0.3245469522240527,"last_synced_commit":"6aa67d574708899b9807f4ed14c61edcf4fa922c"},"previous_names":["hxtree/galaxyops"],"tags_count":308,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hxtree%2Fgalaxyops","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hxtree%2Fgalaxyops/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hxtree%2Fgalaxyops/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hxtree%2Fgalaxyops/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hxtree","download_url":"https://codeload.github.com/hxtree/galaxyops/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248585235,"owners_count":21128969,"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-v2","co-op","cqrs-pattern","devops","event-driven","monorepo","nestjs","nx","platform-engineering","reactjs","rpg-game","serverless","typescript"],"created_at":"2024-10-15T10:06:11.532Z","updated_at":"2025-04-13T15:34:50.077Z","avatar_url":"https://github.com/hxtree.png","language":"JavaScript","readme":"# @galaxyops :milky_way:\n\n@galaxyops: Empowering Efficient Project Management and Accelerated\nDomain-Driven DevOps on AWS.\n\n[![CI](https://github.com/hxtree/galaxyops/actions/workflows/on-merge.yml/badge.svg)](https://github.com/hxtree/galaxyops/actions/workflows/on-merge.yml)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8024531285164025aef972fcb059ea74)](https://app.codacy.com/gh/hxtree/galaxyops/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/8024531285164025aef972fcb059ea74)](https://app.codacy.com/gh/hxtree/galaxyops/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_coverage)\n\n## Overview\n\nRunning multiple applications on AWS without a clear architectural pattern can\nlead to chaos and uncertainty. @galaxyops provides a cloud architecture that\nemphasizes modern DevOps best practices on AWS. It establishes a solid\nfoundation for enterprise software, ensuring scalability and maintainability\nacross projects.\n\n## Features\n\n- **Simple Setup**: Turn-key deployment on bare metal systems, specially\n  designed for compatibility with MacOS silicon environments and without a\n  Docker dependency.\n\n- **Monorepo Architecture**: Centralizes development, streamlining code sharing,\n  versioning, and dependency management with tools like Nx and PNPM.\n\n- **CI/CD Pipeline**: Autonomous pipeline for deploying auditable artifacts to\n  AWS using IaC, ensuring consistency and scalability.\n\n- **Universal Language**: Leveraging TypeScript for microservices, enhancing\n  performance, readability, and maintenance. Other languages can be used for\n  specific tasks, such as Python for data science.\n\n- **Event-Driven Microservices**: Fault-tolerant communication via queues, with\n  event data archived in a data lake for analytics.\n\n- **Schema Contracts**: Automatic mocking and validation for seamless\n  inter-service communication and data integrity.\n\n- **Ephemeral Environments**: Provisioning of TLS certificates and email\n  services using AWS Org Formation.\n\n- **User Authentication**: Integration of Cognito for user registration and\n  authentication.\n\n- **SPA Frontend with BFF**: Single-page application with frontend hosted on S3\n  and deployed via CloudFront, with middleware for backend operations.\n\n## Getting Started\n\nInstall the package manager, jq, build all packages, and hydrate dotenv files:\n\n```bash\n# Enable PNPM package manager\ncorepack enable pnpm\n\n# Install jq for lambda layer builder on MacOS\nbrew install jq\n\n# Install all dependencies\npnpm install\n\n# Hydrate environment files\npnpm nx run galaxyops:hydrate\n```\n\nRun any script using Nx by specifying the package name followed by the script\nname, e.g.\n\n```bash\npnpm nx run admin-client:dev\n```\n\n### Common Commands\n\n```bash\npnpm update                     # Update workspace files.\npnpm add @a/b                   # Add a new package to the app.\npnpm up -r --workspace --interactive # Make package versions consistent.\npnpm nx run-many -t [command] --all # Run a command in bulk.\npnpm nx run package:[command]    # Run a command in the current package.\npnpm nx run package:build        # Build projects.\npnpm nx run package:watch        # Watch for changes and compile.\npnpm nx run package:lint         # Perform ESLint static analysis.\npnpm nx run package:test         # Test a package.\npnpm nx run package:test:cov     # Run tests with coverage.\npnpm nx run package:docs         # Generate documentation from code.\npnpm nx run package:cdk:bootstrap # Bootstrap the CDK project.\npnpm nx run package:cdk:synth    # Show synthesized CloudFormation template.\npnpm nx run package:cdk:diff     # Compare deployed stack with current state.\npnpm nx run package:cdk:deploy   # Deploy apps using AWS CDK.\npnpm nx run package:cdk deploy --hotswap # Speed up dev deployment.\npnpm nx run package:cdk watch    # hot swap on changes.\npnpm nx run package:cdk doctor    # Check CDK project for issues.\npnpm nx release                   # Create a release for all package changes.\npnpm nx dep-graph                 # Visualize dependencies.\n```\n\n### Target Architecture Diagram\n\n![Flow Chart](docs/flow-chart.drawio.svg)\n\n### AWS Multi-Account Architecture Initial Setup\n\nThese steps are required once by the platform team to initialize the IaaS.\n\n1. Setup [AWS Org Formation](/platform/aws-org-formation/README.md).\n\n2. Set an environmental variable in the shell configuration file to establish a\n   default AWS CLI profile for seamless authentication and resource access.\n\n   ```bash\n   echo 'export AWS_PROFILE=DeveloperSandbox' \u003e\u003e ~/.zshrc\n   ```\n\n3. Login via SSO and bootstrap deployments. Deploy platform, services, and then\n   clients in that order.\n\n   ```bash\n    aws configure sso\n    pnpm nx run galaxyops:cdk:bootstrap:sandbox\n    pnpm nx run galaxyops:cdk:deploy:sandbox\n   ```\n\n4. Login via SSO to tools account and then deploy tools.\n\n   ```bash\n   pnpm nx run galaxyops:cdk:bootstrap:tools-account\n   pnpm nx run galaxyops:cdk:deploy:tools-account\n   ```\n\n## Documentation\n\nComprehensive documentation is essential for understanding and maintaining this\nproject. Each project and folder structure should feature a README.md files\ncontaining documentation following RFC 2119 standards.\n\n\u003cdetails\u003e\n  \u003csummary\u003eThird Party Documentation\u003c/summary\u003e\n\n- [NX Package Based Repo](https://nx.dev/getting-started/tutorials/package-based-repo-tutorial)\n- [AWS CLI](https://docs.aws.amazon.com/cdk/v2/guide/cli.html)\n- [Typescript](https://www.typescriptlang.org/docs/)\n- [Jest](https://jestjs.io/)\n- [Automatically Version with Conventional Commits](https://nx.dev/recipes/nx-release/automatically-version-with-conventional-commits)\n\u003c/details\u003e\n\n## Contributing\n\nPull requests and bug reports are welcome on GitHub at\n\u003chttps://github.com/hxtree/galaxyops\u003e. Please follow the\n[code of conduct](docs/CODE_OF_CONDUCT.md) when contributing.\n\n### Acknowledgements\n\n\u003ca href=\"https://github.com/hxtree/galaxyops/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=hxtree/galaxyops\" /\u003e\n\u003c/a\u003e\n\n## License\n\nThis project is mostly licensed under the MIT License. Detailed license\ninformation, including exceptions for packages that are not MIT licensed, can be\nfound in the [LICENSE.md](./LICENSE.md) file. All packages published under the\n[@galaxyops](https://www.npmjs.com/search?q=%40galaxyops) namespace on NPM are\nalso MIT licensed unless otherwise specified.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhxtree%2Fgalaxyops","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhxtree%2Fgalaxyops","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhxtree%2Fgalaxyops/lists"}