https://github.com/jefferson1104/ask-me-anything-server

This is an API developed in Go for an AMA (Ask Me Anything) project, where users can create rooms, ask questions, and interact in real-time. The API includes both REST endpoints and WebSocket to ensure real-time communication.
https://github.com/jefferson1104/ask-me-anything-server

docker go golang postgresql

Last synced: 2 days ago
JSON representation

This is an API developed in Go for an AMA (Ask Me Anything) project, where users can create rooms, ask questions, and interact in real-time. The API includes both REST endpoints and WebSocket to ensure real-time communication.

• Host: GitHub
• URL: https://github.com/jefferson1104/ask-me-anything-server
• Owner: jefferson1104
• Created: 2024-08-05T20:39:26.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-27T23:41:58.000Z (3 months ago)
• Last Synced: 2024-08-29T00:09:01.269Z (3 months ago)
• Topics: docker, go, golang, postgresql
• Language: Go
• Homepage:
• Size: 24.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  


    
AMA API - Ask Me Anything

  


  


    

    

    

  



## :memo: About project

This is an API developed in Go for an AMA (Ask Me Anything) project, where users can create rooms, ask questions, and interact in real-time. The API includes both REST endpoints and WebSocket to ensure real-time communication.

## 🛠️ Features

- **Room Creation**: Users can create different rooms to hold Q&A sessions.

- **Question Management**: Within each room, users can ask questions, which can receive likes and be marked as answered.

- **Real-Time Interaction**: Using WebSocket, all interactions, such as new questions and likes, are updated in real-time for all participants in the room.

## ⚡ Technologies Used

- **Go (Golang)**: Programming language used to develop the API.

- **PostgreSQL**: Relational database used to store room, question, and interaction data.

- **WebSocket**: Implemented to provide real-time updates between clients and the server.

- **Docker Compose**: Used to simplify the setup and management of the development environment, including the PostgreSQL container configuration.

## :cyclone: Run this project

```bash

# clone this repository

git clone https://github.com/jefferson1104/Ask-Me-Anything-Server

# go to the folder

cd Ask-Me-Anything-Server

# environment file

rename the .env.example file to .env

# Run docker file

$ docker compose up -d

# Run go server

go run ./cmd/ama/main.go

```