README.md

AITU UCMS comments service

Table of Contents

1. About The Project
   • Built With
2. Protofiles
3. Websockets API
4. Getting Started
   • Prerequisites
   • Installation

About The Project

This is a simple comments service for AITU UCMS project. It is a part of the project, which is a web application for managing the university's clubs. The service allows users to leave comments on the content of the AITU UCMS.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Protofiles

• Protofiles Repository

(back to top)

Websockets API

Getting Started

Prerequisites

• Go version 1.22.3

• Docker 26.1.4

• Docker Compose 2.27.1

• Taskfile 3

    go version
    docker --version
    docker-compose --version

Installation

1. Clone the repo

   git clone https://github.com/ARUMANDESU/uniclubs-comments-service.git

2. Change directory

   cd uniclubs-comments-service

3. Write the environment variables in the .env file

   ENV=dev
   
   START_TIMEOUT=
   SHUTDOWN_TIMEOUT=
   
   HTTP_ADDRESS=
   HTTP_TIMEOUT=
   HTTP_IDLE_TIMEOUT=
   
   GRPC_PORT=
   GRPC_TIMEOUT=
    
   MONGODB_URI=mongodb://<user>:<password>@<host>:<port>
   MONGODB_PING_TIMEOUT=10s
   MONGODB_DATABASE_NAME=<your_database_name>
    
   RABBITMQ_USER=<user>
   RABBITMQ_PASSWORD=<password>
   RABBITMQ_HOST=<host>
   RABBITMQ_PORT=<port>
   
   USER_SERVICE_ADDRESS=<host>:<port>
   USER_SERVICE_TIMEOUT=10s
   USER_SERVICE_RETRIES_COUNT=2
   
   JWT_SECRET=

4. Run the service

   task r:e

(back to top)