Before getting started, ensure you have the following installed and configured:
- Go Language: Make sure Go is installed on your system. You can download it from golang.org.
- Linux or WSL: Use a Linux environment or Windows Subsystem for Linux (WSL) for seamless development.
Follow the steps below to set up and run the project:
This require AWS_SASL_IAM Config to connect to the kafka cluster
Use the make
command to build and run the server:
make server
This will start the Go server and handle any dependencies or build requirements automatically.
The repository is structured as follows:
.
├── cmd/ # Entry point for the application
├── pkg/ # Package modules
├── internal/ # Internal application logic
├── configs/ # Configuration files
├── kafka.yml # Docker Compose file for Kafka
├── Makefile # Makefile with useful commands
├── README.md # Project documentation
└── ...
Once the server is running, you can interact with it through the specified API endpoints. Ensure that Kafka is up and running before starting the server to avoid connectivity issues.