feat: refactor clients

Signed-off-by: hxtree <[email protected]>

docs/devcontainer.md → .devcontainer/README.md

@@ -1,4 +1,4 @@
-# Devcontainer
+# .devcontainer
 
 The following Getting Started instructions explain how to develop locally using
 a devcontainer.
@@ -16,9 +16,3 @@ a devcontainer.
 
 3. Open repo Project Folder using VSCode and build and connect to remote
    container.
-
----
-
-> **Note** Development of `@cats-cradle/base-game-engine` client which is built
-> using Unreal Engine 5. requires
-> [additional tools](clients/base-game-engine/README.md).

README.md

@@ -1,68 +1,63 @@
-<h1 align="center">Cats Cradle :yarn:</h1>
-
-**AWS Enterprise Monorepo**
+# @cats-cradle
 
 [![CI](https://github.com/hxtree/cats-cradle/actions/workflows/on-merge.yml/badge.svg)](https://github.com/hxtree/cats-cradle/actions/workflows/on-merge.yml)
 [![Code Quality](https://app.codacy.com/project/badge/Grade/8024531285164025aef972fcb059ea74)](https://www.codacy.com/gh/hxtree/cats-cradle/dashboard?utm_source=github.com&utm_medium=referral&utm_content=hxtree/cats-cradle&utm_campaign=Badge_Grade)
 [![Codacy Coverage](https://app.codacy.com/project/badge/Coverage/8024531285164025aef972fcb059ea74)](https://app.codacy.com/gh/hxtree/cats-cradle)
 [![GitHub Stars](https://img.shields.io/github/stars/hxtree/cats-cradle?style=social)](https://github.com/hxtree/cats-cradle/stargazers)
 
-Welcome to the open-source platform for enterprise architecture! This repository
-houses a collection of event-driven microservices, built on a powerful Platform
-as a Service (PaaS) foundation. The integration of Infrastructure as Code (IaC)
-ensures a streamlined DevOps pipeline for continuous integration and continuous
-deployment (CI/CD) leverage the power of AWS.
-
-## Overview
-
-This monorepo is designed to provide a modular and scalable architecture for
-enterprises looking to embrace modern software development practices. The use of
-event-driven microservices enables flexibility, scalability, and responsiveness
-to changing business needs.
+An **open-souce enterprise monorepo** designed to provide a modular and scalable
+architecture for enterprises looking to **accelerate** using modern software
+devops practices.
 
 ## Key Features
 
 - **Microservices Architecture:** The repository is organized into modular
   microservices, each focusing on specific business functionalities. This design
   promotes maintainability, scalability, and ease of deployment.
 
-- **Platform as a Service (PaaS):** Leveraging a PaaS foundation simplifies
-  infrastructure management and allows developers to focus on writing code
-  without worrying about the underlying infrastructure.
-
 - **Event-Driven Design:** The microservices communicate through events,
   allowing for loosely coupled components and enabling efficient handling of
-  business processes.
-
-- **Infrastructure as Code (IaC):** The entire infrastructure is defined as
-  code, allowing for version control, easy replication, and consistent
-  environments across different stages of the development lifecycle.
+  business processes. The use of event-driven microservices enables flexibility,
+  scalability, and responsiveness to changing business needs.
 
 - **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.
+  lifecycle. Services are released on
+  [Github](https://github.com/hxtree/cats-cradle/releases). Reusable libraries
+  are published on [NPM](https://www.npmjs.com/search?q=%40cats-cradle).
 
----
+- **Platform as a Service (PaaS):** Leveraging a PaaS foundation simplifies
+  infrastructure management and allows developers to focus on writing code
+  without worrying about the underlying infrastructure.
 
-While specific services and packages are actively maintained for the development
-of Cats Cradle, a nostalgic co-op RPG, the repository functions as a foundation
-for architecting monorepos. Services are individually released. Libraries are
-published on [NPM](https://www.npmjs.com/search?q=%40cats-cradle).
+- **Infrastructure as Code (IaC):** The entire infrastructure is defined as
+  code, allowing for version control, easy replication, and consistent
+  environments across different stages of the development lifecycle.
+
+This repository functions as a foundation for architecting monorepos. In
+addition, many example packages are actively used in the development of a
+nostalgic co-op RPG.
 
 ## Getting Started
 
-For a turn-key development environment,
-[fork the repo](https://github.com/hxtree/cats-cradle/fork) and open in Github
-Codespaces.
+Start up an instant turn-key development environment by
+[forking the repo](https://github.com/hxtree/cats-cradle/fork) and open in
+Github Codespaces.
 
 [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=438855397)
 
-Alternatively, build, test, and deploy apps locally using the
-[devcontainer](docs/devcontainer.md).
+Alternatively, git clone the repo and build, test, and deploy apps locally using
+the [devcontainer](.devcontainer/README.md).
 
 ## Architecture
 
+This repository houses a collection of event-driven microservices, built on a
+powerful Platform as a Service (PaaS) foundation. The integration of
+Infrastructure as Code (IaC) ensures a streamlined DevOps pipeline for
+continuous integration and continuous deployment (CI/CD) leveraging the power of
+AWS.
+
 ![Flow Chart](docs/flow-chart-dark.drawio.svg)
 
 ### Pull Request Lifecycle (~5 mins)
@@ -115,8 +110,9 @@ See [Documentation](docs/index.md).
 
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
 
-Join us on this development journey as we develop and bring the game to life.
-Contribute to any part of the monorepo to help shape the game.
+Contribute to any part of the monorepo. Join us on this development journey as
+we build an open-source enterprise monororepo and/or develop bring the game to
+life.
 
 Pull requests and bug reports are welcome on GitHub at
 <https://github.com/hxtree/cats-cradle>. This project is intended to be a safe,

clients/README.md

@@ -1,5 +1,4 @@
 # clients
 
-These are network clients that connect an individual user to the main game
-server. They are used to build the software that the player uses for playing
-game.
+These are frontend clients. Each client connects to services often through a
+dedicated backend for frontend.