@taktikorg/maiores-architecto

v1.9.87

Published

8 days ago

[![CI](https://github.com/taktikorg/maiores-architecto/actions/workflows/on-merge.yml/badge.svg)](https://github.com/taktikorg/maiores-architecto/actions/workflows/on-merge.yml) [![Code Quality](https://app.codacy.com/project/badge/Grade/8024531285164025a

Downloads

1,726

0High
0Medium
0Low

lechuongb878

jQuery findLastIndex Uint8Array RFC-6455 push css variable a11y description babel stateless logger fnmatch stylesheet file deepcopy loading mapreduce es-abstract ebs nodejs css nesting random flux Float64Array l10n estree hash functions hasOwnProperty moment prune joi javascript column babel-core identifiers loadbalancing path curl mock redact valid utilities trimEnd bundling typed array getOwnPropertyDescriptor flat signal compare Array.prototype.contains Uint32Array shim text styles fastcopy YAML iterator streams proto gradients css3 variables const Reflect.getPrototypeOf tester ArrayBuffer.prototype.slice api react ES2022 circular colors typeerror ignore hooks cloudwatch own walk .gitignore quote Object.entries window amazon read cache css-in-js password log CSSStyleDeclaration transpile rapid value HyBi drop computed-types manager gdpr css less codes hookform idle persistent __proto__status optimist plugin higher-order less compiler .env uninstall minimal lru date mkdirp mocking full-width ajv call-bind superstruct callbind es8 trimStart yaml expression clone react-testing-library handler native picomatch crypto slice parser channel collection.es6 espree ses forEach Array environment command-line execute var libphonenumber values dependencies tc39 autoprefixer deepclone auth ES2017 emit Object.is mixins url self sorted require ES coercible config es6 polyfill dependency manager scheme-validation typedarray jshint fast-deep-copy transpiler cloudfront npmignore figlet pino dotenv match ES7 flag error queue ES2021 async postcss-plugin binary multi-package ES2015 importexport fast-copy stringifier pnpm9 symlink String.prototype.matchAll fast reduce front-end String.prototype.trim es2015 Symbol spec ESnext formatting RegExp.prototype.flags mobile make fastify routing Array.prototype.findLast command sigterm write internal slot array postcss sameValueZero getopt pipe gradients css live validation toolkit js RxJS redux-toolkit Set WebSockets storagegateway flags fp cloudtrail invariant Stream assertion extra iterate BigInt64Array binaries japanese output eslint recursive spinner preprocessor validator rds Uint8ClampedArray tslib has ArrayBuffer#slice Object runtime typed classes eslintconfig xterm Object.assign globals jwt typeof validate ECMAScript 2018 preserve-symlinks exec collection import descriptors parse trimLeft util deep-copy chrome ES3 remove offset chinese upload time fast-deep-clone styling lockfile service eventDispatcher JSON compiler commander simpledb typesafe es2016 length Symbol.toStringTag input view Object.getPrototypeOf matches react pose variables in css ramda private data point-free react animation art protocol-buffers io-ts patch scheme Rx macos obj consume internal arktype react-component toobject flatMap jsdom getPrototypeOf superagent assign getter real-time omit iam cjk data Int16Array harmony gitignore tty jsx package.json typanion WeakMap entries es7 shrinkwrap regex eslintplugin URLSearchParams ec2 take curried nested css module spring popmotion bdd child vars check side yup framer pure bind accessibility copy signals graphql diff @@toStringTag object reuse trimRight reducer stable color argv less hasOwn intrinsic 256 less mixins electron wget fastclone styled-components browser [[Prototype]]authentication form request rules typedarrays TypeScript error-handling asserts bcrypt Observables global object bin tdd serializer JSON-Schema ES2023 class-validator define local elm lint Map concat number deep sham some eslint-plugin every console generics properties speed find efficient es-shim API ast width regular expression autoscaling interrupts terminal effect-ts functional ES5 prop awesomesauce route53 flatten redux testing packages Array.prototype.includes fantasy-land move link full dayjs once Object.values Object.keys visual byteLength globalThis sns sequence ES6 filter redirect elb findLast bootstrap css ReactiveX pretty file system tostringtag includes promise arrays ajax lesscss core-js acorn ECMAScript 2016 type language lazy callbound css dynamodb env rgb Promise hardlinks setter buffer es2018 dir iteration workflow toSorted writable json-schema install phone fullwidth certificates dom spinners exit cli concatMap waf proxy s3 dataView core call-bound ie private group Function.prototype.name pyyaml property server make dir es5 es2017 elasticache location buffers

@cats-cradle

The problem

Running multiple applications in the cloud without a solid architectural framework is akin to constructing a house without blueprints - it invites chaos. While many resources focus solely on single-application setups, cloud architecture encompasses an entire city, not just one building. Without a coherent plan in place, any attempt to make changes becomes a daunting task.

This solution

This cloud architecture focuses on modern DevOps practices on AWS[^1]. This approach transcends individual projects; we're laying the groundwork for the entire landscape of enterprise software on AWS.

It's a practical demonstration featuring tangible code, driving a cooperative RPG.

Features

The below features outline the principles and standards applicable to this repository. Each piece contributes harmoniously to the overall cityscape we're constructing.

A package base monorepo approach is preferred as to create a clear separation in layers. Microsoft backed Rush was selected over Nx, Lerna, Turbo, etc. for monorepo management. Nx is also suitable, but rush has worked fine so far.

The code is divided into several categories: libraries, platform, services, middleware, and clients. Each is further defined in there retrospective folders. When it comes to individual package files, those that typically change in tandem SHOULD generally be kept together. The organization of code SHOULD be based on features. All project dependencies MUST be unidirectional dependencies.

We selected AWS as our Infrastructure as a Service (IaaS) provider because of the advantages of vendor lock-in, allowing us access to a diverse array of standardized services. In this project, prioritizing these benefits takes precedence over maintaining cloud agnosticism. We anticipate potential project failure before AWS, and we've accounted for the potential cost of migrating between IaaS providers. Our approach involves intentional structuring of layers and relies primarily on features offered by multiple cloud providers.

The entire infrastructure is defined as code, allowing for version control, easy replication, and consistent environments across different stages of the development lifecycle. All Infrastructure as Code MUST be defined as or compile to CloudFormation templates.

Getting Started

Setting up Development Environment

The quickest way to start a develop environment is by clicking open in Github Codespaces. To actually save and commit changes back it is recommended to forking the repo .

Alternatively, git clone and install locally using a devcontainer. It's possible to install without a container using the Dockerfile as guidance on package to install.

Flow Chart

Implementing AWS Multi-Account Architecture

These steps only need to be performed once by the platform team to initalize the IaaS.

Setup AWS Org Formation.

rush sso
rush cdk:bootstrap
rush cdk:deploy --to tag:deploy-platform
rush cdk:deploy --to tag:services
rush cdk:deploy --to tag:middleware
rush cdk:deploy --to tag:clients

rush sso -p tools
rush cdk:bootstrap
rush cdk:deploy --to tag:deploy-tools

Documentation

Documentation SHOULD be maintained where it will be looked for. A README.md file SHOULD be added to explain each project and important folder structures. README.md files instructions should adhere to RFC 2119[^2]. Any code that isn't self-documenting MUST be accompanied by documentation. Tsdoc MAY be selected as a standard for writing Typescript documentation. Typedoc MAY be selected to compile documentation as code.

Note Use rush help for information on builtin commands.

Contributing

We welcome contributions of any size to this open-source project. Please follow the code of conduct when contributing.

Pull requests and bug reports are welcome on GitHub at https://github.com/taktikorg/maiores-architecto.

Checkout a new branch from main using git.
```
git checkout -b feature/improve-readme
```
Work on changes (e.g. fix a bug or add a new feature). Test-driven development encouraged.
```
rushx dev
rushx test
```

Stage and commit changes using conventional commits.

git add .
git commit -m 'doc: fix spelling of computers'

(Optional) If changing a library that is published to NPM, document semantic version changes, generate Changelogs, and commit changes.
```
rush change
rush version --bump
git commit -m 'chore: bump change log'
```
Push code and open a PR. Celebrate contributing to @cats-cradle.
```
git push
```

Acknowledgements

License

Packages available on NPM are MIT licensed. Packages without a specific license have not yet been developed with reuse in mind and are primarily maintained for the game. Simply remove these projects when setting up your architecture.

[^1]: Accelerate: The Science of Lean Software and DevOps: Building and Scaling High Performing Technology Organizations Paperback – Illustrated, March 27, 2018 by Nicole Forsgren PhD (Author), Jez Humble (Author), Gene Kim (Author).

[^2]: This document adheres to the guidelines outlined in RFC 2119, which defines the standard interpretations of key words used in IETF documents. These key words include "MUST", "MUST NOT", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL". The usage of these words in this document follows the specifications set forth in RFC 2119, ensuring clarity and consistency in the requirements and recommendations presented herein.