Skip to content

Commit

Permalink
Merge pull request #857 from hxtree/feature/update-pgk-3
Browse files Browse the repository at this point in the history
Update dependencies
  • Loading branch information
hxtree authored Mar 5, 2024
2 parents d464212 + 5983287 commit fee793b
Show file tree
Hide file tree
Showing 60 changed files with 893 additions and 492 deletions.
41 changes: 22 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ developing a cooperative RPG.
- Turn-key development environment with Github Codespaces.
- Emphemiral environments with TLS certifcates, email, etc.
- Event-driven microservices architecture with data lake.
- Interservice schema contracts, offering automatic mocking, faking, and
validation pipes for seamless development and data integrity.
- Infrastructure as Code (IaC) for streamlined DevOps pipeline.
- Continuous integration and continuous deployment (CI/CD) leveraging AWS.
- Happy Engineers.
Expand Down Expand Up @@ -57,15 +59,16 @@ monorepo instead of polyrepo. Apps **SHOULD** be mostly serverless
microservices. Not every bit of code the organization maintains should go into
the monorepo, but those that change together stay together.

A package base 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. A package base
approach is preferred as to create a clear separation in layers.
management. Nx is also suitable, but rush has worked fine so far.

The structure of the parent project folder **MUST** follow the pattern
established by Microsoft Rushstack. When it comes to individual package files,
those that typically change in tandem **SHOULD** be kept together. The
organization of code **SHOULD** be based on features. The code is divided into
several categories: libraries, platform, services, middleware, and clients.
established by Microsoft Rushstack. 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** be kept together. The organization of
code **SHOULD** be based on features.

#### Universal language

Expand All @@ -91,9 +94,8 @@ compile to CloudFormation templates.

AWS CDK **MUST** be selected for generating Cloudformation templates. The only
exception is for platform which **MAY** use AWS Org Formation or other

Cloudformation abstraction layers. CDK works well for generating most L1 and L2
Constructrs. L3 Constructs are created more business specific and should be
Constructrs. L3 Constructs are created more business specific and **SHOULD** be
maintained by platform rather than a third party.

#### Deployments
Expand All @@ -102,11 +104,11 @@ Each app **MUST** be capable of deployment themselves of using CDK via
`rushx cdk:deploy`. This command **MAY** also be used in local development to
deploy services.

During CI, an artifact from each project **MUST** be uploaded to S3. This
artifact **SHOULD** be processed by AWS CodePipeline for CD.
During CI, an artifact from each project **MUST** be generated and uploaded to
S3. This artifact **SHOULD** be processed by AWS CodePipeline for CD.

<details>
<summary>Provisioning</summary>
<summary>Initial Infrastructure Provisioning</summary>

1. Setup [AWS Org Formation](/platform/aws-org-formation/README.md).

Expand Down Expand Up @@ -136,10 +138,10 @@ artifact **SHOULD** be processed by AWS CodePipeline for CD.

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 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.
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.
Expand All @@ -158,8 +160,8 @@ selected to compile documentation as code.

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

We welcome contributions to this open-source project. Please follow the
[code of conduct](docs/CODE_OF_CONDUCT.md) when contributing.
We welcome contributions of any size to this open-source project. Please follow
the [code of conduct](docs/CODE_OF_CONDUCT.md) when contributing.

Pull requests and bug reports are welcome on GitHub at
<https://github.com/hxtree/cats-cradle>.
Expand Down Expand Up @@ -217,7 +219,8 @@ Pull requests and bug reports are welcome on GitHub at

Packages available on [NPM](https://www.npmjs.com/search?q=%40cats-cradle) are
MIT licensed. Packages without a specific license have not yet been developed
with reuse in mind and are primarily maintained for the game.
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
Expand All @@ -232,4 +235,4 @@ with reuse in mind and are primarily maintained for the game.
"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.
and consistency in the requirements and recommendations presented herein.
2 changes: 1 addition & 1 deletion clients/admin-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"aws-cdk-lib": "2.129.0",
"@testing-library/react": "^14.0.0",
"@testing-library/jest-dom": "^5.16.5",
"ts-jest": "29.1.1",
"ts-jest": "29.1.2",
"@types/jest": "29.5.11",
"jest": "29.7.0",
"jest-environment-jsdom": "~29.6.1",
Expand Down
17 changes: 17 additions & 0 deletions clients/design-system/CHANGELOG.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
{
"name": "@cats-cradle/design-system",
"entries": [
{
"version": "0.5.4",
"tag": "@cats-cradle/design-system_v0.5.4",
"date": "Tue, 05 Mar 2024 05:29:22 GMT",
"comments": {
"patch": [
{
"comment": "update deps"
}
],
"dependency": [
{
"comment": "Updating dependency \"@cats-cradle/base-nodejs\" to `1.0.12`"
}
]
}
},
{
"version": "0.5.3",
"tag": "@cats-cradle/design-system_v0.5.3",
Expand Down
9 changes: 8 additions & 1 deletion clients/design-system/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Change Log - @cats-cradle/design-system

This log was last generated on Sun, 04 Feb 2024 05:29:40 GMT and should not be manually modified.
This log was last generated on Tue, 05 Mar 2024 05:29:22 GMT and should not be manually modified.

## 0.5.4
Tue, 05 Mar 2024 05:29:22 GMT

### Patches

- update deps

## 0.5.3
Sun, 04 Feb 2024 05:29:40 GMT
Expand Down
4 changes: 2 additions & 2 deletions clients/design-system/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@cats-cradle/design-system",
"private": false,
"version": "0.5.3",
"version": "0.5.4",
"module": "commonjs",
"main": "dist/main.js",
"types": "dist/main.d.ts",
Expand Down Expand Up @@ -113,7 +113,7 @@
"jest": "29.7.0",
"sass": "^1.47.0",
"storybook": "7.6.3",
"ts-jest": "29.1.1",
"ts-jest": "29.1.2",
"uuid": "~9.0.1",
"@storybook/addon-styling": "~1.3.7",
"@types/lodash": "~4.14.202",
Expand Down
8 changes: 4 additions & 4 deletions clients/jukebox/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,19 +54,19 @@
"@types/node": "20.10.5",
"@types/aws-lambda": "~8.10.130",
"jest": "29.7.0",
"ts-jest": "29.1.1",
"ts-jest": "29.1.2",
"@microsoft/tsdoc": "~0.13.2",
"typescript": "5.3.3",
"ts-node": "10.9.2",
"esbuild": "~0.17.5",
"fs": "~0.0.1-security",
"esbuild": "~0.20.1",
"fs": "~0.0.2",
"path": "~0.12.7",
"@types/express": "~4.17.21",
"@types/uuid": "~9.0.7",
"eslint": "8.56.0",
"@cats-cradle/eslint-config": "1.0.11",
"@nestjs/testing": "9.2.1",
"supertest": "~6.3.3",
"supertest": "~6.3.4",
"@types/supertest": "~2.0.16",
"@cats-cradle/faker-factory": "workspace:*",
"@fastify/static": "~6.9.0",
Expand Down
Loading

0 comments on commit fee793b

Please sign in to comment.