Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.22 KB

README.md

File metadata and controls

52 lines (34 loc) · 1.22 KB
Raw

opendiscuss

Opendiscuss is a community platform where people contribute to discuss various topics.

User Stories

You can find user stories in the file README-user-story.md.

Entiry Relationship Diagram

You can view the ERD on dbdiagram and dbdocs.

erd

Quick Start

You can check this youtube video for Quick Start Opendiscuss.

  1. Rename .env-example to .env.

  2. Run the MySQL database and the Go app using Docker Compose:

sudo docker compose up --build

MySQL credentials is:

DB_USER="user"
DB_PASSWORD="password"
DB_HOST="localhost"
DB_PORT="9306"
DB_NAME="opendiscuss"

Test hit API login:

curl --location 'http://localhost:9080/api/v1/login' \
--header 'Content-Type: application/json' \
--data '{
    "username": "abdan",
    "password": "abdan"
}'

Check README-user-story.md for other API.

API Documentation

For API documentation, you can import the file postman/opendiscuss.postman_collection.json into your Postman.