Skip to content

Commit

Permalink
fix: update readmes
Browse files Browse the repository at this point in the history
Signed-off-by: hxtree <[email protected]>
  • Loading branch information
hxtree committed Feb 11, 2024
1 parent cab10d0 commit d7b9aaf
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 17 deletions.
10 changes: 0 additions & 10 deletions .github/README.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/recommended-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,3 @@ MongoDB Atlas. [Register](https://www.mongodb.com/cloud/atlas/register)
than [1 month of AWS DocumentDB](https://aws.amazon.com/documentdb/pricing/).
- MongoDB can be ran locally, if needed.
- MongoDB is scalable and used in high-performance video games.

## Object Modeling

Mongoose

- TypeORM has poor support for MongoDB; it's more for RDMS.
- Using an ORM is a bit too lambdalith.
5 changes: 5 additions & 0 deletions libraries/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ directory or platform away from source code as to keep code clean and readable.
> the versions of packages that depend on the updated one be made. This approach
> ensures clear and organized version management within the monorepo.
## Release

Reusable libraries are published on
[NPM](https://www.npmjs.com/search?q=%40cats-cradle).

## Documentation

- [Rule of three](<https://en.wikipedia.org/wiki/Rule_of_three_(computer_programming)>)
5 changes: 5 additions & 0 deletions libraries/nestjs-modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ are as follows:
- **MessageService**: A service that uses a schema abstraction layer on top of
SnsService to make publishing, subscribing, and testing events that adhere to
a schema even easier.
- **MongooseModule** In terms of object modeling, Mongoose is preferred over
TypeORM due to TypeORM's limited support for MongoDB, which is more suited for
relational database management systems (RDMS), making it somewhat cumbersome
for MongoDB usage. Additionally, employing an ORM like TypeORM may introduce
unnecessary complexity, aligning with the lambdalith architectural style.
- **rootMongooseModule**: Makes interacting and testing with persistent data in
MongoDB using Mongoose easier. Do not use this inside tests.
- **rootMongooseTestModule**: Makes testing Mongoose easier using a
Expand Down
5 changes: 5 additions & 0 deletions platform/pipeline/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ CDK_NEW_BOOTSTRAP=1 cdk bootstrap
aws://298217020330/us-east-2 \
```

- **DevOps CI/CD:** The repository includes a robust DevOps pipeline for
continuous integration and continuous deployment. Automated testing, build,
and deployment processes ensure a smooth and reliable software delivery
lifecycle.

## Documentation

- [CDK Pipeline](https://docs.aws.amazon.com/cdk/v2/guide/cdk_pipeline.html)
5 changes: 5 additions & 0 deletions services/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ important guidelines:
└─ stack - # CDK deployment code.
```

## Release

Services are released on
[Github](https://github.com/hxtree/cats-cradle/releases).

## References

- [Structuring Monorepos](https://danoncoding.com/monorepos-for-microservices-part-2-code-structure-e2bddac3474d)

0 comments on commit d7b9aaf

Please sign in to comment.