TC-Chat Application

This is a Go-based chat application that uses Docker and Docker Compose for containerization. The application is built with a slice architecture and leverages PostgreSQL as its database , uses Templ, HTMX, Tailwindcss, Alpinejs.

Prerequisites

Before you begin, ensure you have the following software installed on your machine:

• Docker
• Docker Compose
• Make
• Templ
• HTMX
• Tailwindcss
• Alpinejs

Installation

1. Clone the repository:

   git clone https://github.com/your-username/tc-chat.git
   cd tc-chat
   

2. Build templ go files:

   Use the Makefile to build go files from templ components.

   make gen
   

3. Build the Docker images:

   Use the Makefile to build the Docker images.

   make build
   

Usage

Running the Application

To start the application along with the PostgreSQL database, run:

make up
 
This will start the services defined in the docker-compose.yml file.

This will start the services on port http://localhost:8080.

Stopping the Application To stop the running services, execute:

make down

Makefile Commands make env: Exports the CONFIG_PATH environment variable. make build: Builds the Docker images using Docker Compose. make up: Starts the Docker containers in detached mode. make down: Stops and removes the Docker containers. make logs: Displays the logs from the Docker containers. make restart: Restarts the Docker containers. Configuration The application configuration is managed through the local.yaml file located in the config/ directory. This file includes database connection details, server configurations, and other application settings.