gen

README

Ask Me Anything (AMA) Application

Overview

Welcome to the Ask Me Anything (AMA) application! This project is a real-time platform where users can ask questions and receive answers in a live, interactive environment. The backend is built with Go, leveraging WebSocket for real-time communication.

Table of Contents

• Features
• Tech Stack
• Getting Started
  • Prerequisites
  • Installation
  • Running the Application
• Acknowledgments
• Contact

Features

• Real-time Q&A: Users can ask and answer questions in real-time.
• Room-Based Discussions: Create rooms for different topics or sessions.
• WebSocket Integration: Low-latency communication using WebSocket.

Tech Stack

• Backend: Go (Golang)
• WebSockets: For real-time communication
• Database: PostgreSQL (running in Docker)
• Containerization: Docker

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Go
• Docker

Installation

1. Clone the repository:

   git clone https://github.com/igorjpimenta/AskMeAnything.git
   cd AskMeAnything
   
   

2. Install dependencies:

   go mod download
   
   

3. Run PostgreSQL in Docker:

   docker-compose up -d
   
   

4. Run database migrations::

   go generate ./...
   
   

Running the Application

1. Run the backend server:

   go run ./cmd/main.go
   
   

2. The backend server will start on http://localhost:8080

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Inspired by an event from Rocketseat, the main repo is available here.

Contact

If you have any questions or suggestions, feel free to open an issue or contact the project maintainers.