kitty-chan-domain is a domain microservice layer of the kitty chan Discord Bot. This microservice is responsible for receiving gRPC events from the kitty-chan-events service.
This microservice is the core domain handler which performs all operations related to Bot, Guild and Member. By relying on the shared Redis database, the domain layer effectively manages and synchronizes the information used by all the microservices.
The communication between the different microservices is facilitated through gRPC events, with the kitty-chan-events service being responsible for sending these events to the kitty-chan-domain microservice. The domain layer then processes and handles these events, ensuring that the shared Redis database is accurately updated.
However, it's important to note that the kitty-chan Discord Bot is currently in the early stages of development. This microservice is being actively worked on to enhance its functionality and provide an enjoyable experience to the users.
This guide will help you set up the project on your local machine.
- Node.js v18.17.0 (recommended using nvm)
- MongoDB
- Elastic Search v7.5
- Docker (recommended if running all other kitty chan microservices all together)
- kitty chan Events kitty-chan-events. (Domain microservice receives gRPC events from this events microservice).
-
Install Node.js v18.17.0. You can use nvm to manage Node.js versions.
-
Replace .env.tpl file with the .env including actual values.
-
Install Redis on your local host or if all other kitty chan Microservices are running inside a Docker network, follow these steps:
- Replace the
.env.tlpfile with.envinside the./docker/redispath and fill in the required fields. - Run the
redis.ymlfile from the same directory. This is a one-time setup; once done, it can be used for all kitty chan microservices.
- Replace the
Note: While setting up gRPC config, use
0.0.0.0:portinstead oflocalhost:portto avoid connectivity issues when running inside a Docker environment.
That's it! kitty chan Domain will be up and running!