indramahaarta/chitchat

ChitChat

Welcome to the ChitChat project! This App provides functionality chat with another user

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Configuration
• Usage
  • Running the Server
  • API Documentation
• License

Getting Started

Prerequisites

Ensure you have the following tools installed on your machine:

• Docker

Installation

1. Clone the repository:

   git clone https://github.com/indramahaarta/chitchat.git
   cd chitchat
   

Configuration

1. Configure env file:

   Make a copy from .env.example and fill all the configuration

Usage

Running the Server using /script/setup.sh (docker-compose)

  chmod +x ./script/setup.sh && ./script/setup.sh

Then, open http://localhost:3000 to preview the frontend

API Documentation

To access the API documentation, visit the Swagger documentation at http://localhost:8080/swagger/index.html after starting the server.