Skip to content

Commit

Permalink
chore: Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: deesejohn <deese.john@gmail.com>
  • Loading branch information
deesejohn committed Dec 17, 2023
1 parent d16f014 commit d5bac55
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ This project is a way for me to experiment, evaluate, and demo new technologies.

![Architecture graph](/docs/img/architecture.svg)

| Service | Language / Framework | Notes |
| ----------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Games](services/games) | Go / [gRPC](https://grpc.io/) | Handles game logic, stores state in [Redis](https://redis.io/) and publishes updates to [NATS](https://nats.io/) |
| [Games BFF](services/games-bff) | TypeScript / [Express](https://expressjs.com/) | [ts-rest](https://ts-rest.com/), [Node.js](https://nodejs.org), subscribes to NATS and streams game updates to players in real time with websockets |
| [Games SPA](services/games-spa) | TypeScript / [React](https://reactjs.org/) | Game frontend build with [Vite](https://vitejs.dev/), [Material UI](https://material-ui.com/), [React Hook Form](https://www.react-hook-form.com/), [axios](https://github.com/axios/axios), and hosted via [NGINX](https://www.nginx.com/) |
| [Lobbies](services/lobbies) | C# / [ASP&#46;NET Core](https://docs.microsoft.com/en-us/aspnet/core/?view=aspnetcore-5.0) | Uses [SignalR](https://dotnet.microsoft.com/apps/aspnet/signalr) with a Redis backplane to stream updates to the SPA |
| [Lobbies SPA](services/lobbies-spa) | TypeScript / [Angular](https://angular.io/) | Built with [Angular Material](https://material.angular.io/) and [tailwindcss](https://tailwindcss.com/), allows players to select their team |
| [Players](services/players) | Python / [FastAPI](https://fastapi.tiangolo.com/) | Handles player state with Redis, hosted via [uvicorn](https://www.uvicorn.org/) |
| [Players SPA](services/players-spa) | TypeScript / React | Allows players to set and update their nickname, built with [formik](https://github.com/formium/formik) hosted via NGINX |
| [Words](services/words) | Go / gRPC | Provides different word lists to vary games |
| Service | Language / Framework | Notes |
| ----------------------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Games](services/games) | Go / [gRPC](https://grpc.io/) | Handles game logic, stores state in [Redis](https://redis.io/) and publishes updates to [NATS](https://nats.io/) |
| [Games BFF](services/games-bff) | TypeScript / [Express](https://expressjs.com/) | [ts-rest](https://ts-rest.com/), [Node.js](https://nodejs.org), subscribes to NATS and streams game updates to players in real time with websockets |
| [Games SPA](services/games-spa) | TypeScript / [React](https://reactjs.org/) | Game frontend build with [Vite](https://vitejs.dev/), [Material UI](https://material-ui.com/), [React Hook Form](https://www.react-hook-form.com/), [axios](https://github.com/axios/axios), and hosted via [NGINX](https://www.nginx.com/) |
| [Lobbies](services/lobbies) | C# / [ASP&#46;NET](https://dotnet.microsoft.com) | Uses [SignalR](https://dotnet.microsoft.com/apps/aspnet/signalr) with a Redis backplane to stream updates to the SPA |
| [Lobbies SPA](services/lobbies-spa) | TypeScript / [Angular](https://angular.io/) | Built with [Angular Material](https://material.angular.io/) and [tailwindcss](https://tailwindcss.com/), allows players to select their team |
| [Players](services/players) | Python / [FastAPI](https://fastapi.tiangolo.com/) | Handles player state with Redis, hosted via [uvicorn](https://www.uvicorn.org/) |
| [Players SPA](services/players-spa) | TypeScript / React | Allows players to set and update their nickname, built with [formik](https://github.com/formium/formik) hosted via NGINX |
| [Words](services/words) | Go / gRPC | Provides different word lists to vary games |

### Local development

Expand All @@ -60,7 +60,7 @@ Current dependencies are:
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo add nats https://nats-io.github.io/k8s/helm/charts/
helm repo update
helm install envoy-gateway oci://docker.io/envoyproxy/gateway-helm --version v0.5.0 -n envoy-gateway-system --create-namespace
helm install envoy-gateway oci://docker.io/envoyproxy/gateway-helm --version v0.6.0 -n envoy-gateway-system --create-namespace
helm install nats nats/nats
helm install games-redis bitnami/redis --set architecture=standalone
helm install lobbies-redis bitnami/redis --set architecture=standalone
Expand Down

0 comments on commit d5bac55

Please sign in to comment.