From 17ac5f738d289cb5d685b9ea47d7321c38b39e39 Mon Sep 17 00:00:00 2001 From: Yehor Bublyk <35728917+yehorbk@users.noreply.github.com> Date: Sat, 12 Feb 2022 18:13:45 +0200 Subject: [PATCH] basic project description added --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c2017b7..cafc8d3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ -# forum -Project for Reactive Programming Course +# Forum +Platform for discussing various topics + +## Team +- Yehor Bublyk ([yehorbk](https://github.com/yehorbk)) +- Dmytro Rekechynsky ([rocket111185](https://github.com/rocket111185)) +- Artem Bokii ([lightballer](https://github.com/lightballer)) + +## Stack +- Frontend: `HTML5`, `CSS3`, `Bootstrap`, `JavaScript`, `React` +- Back-end: `Golang` +- Database: `Postgres` +- Other: `Docker`, `GitHub Actions` + +## Models +- `User` +- `Topic` +- `Message` (related to `topic` or another `message`) + +## Use cases +- Sign In / Sign Up +- Create and configure `topic` +- Filter and search `topics` +- Post message to `topic` or response to another `message` +- Like / Dislike `message` +- Follow `topic` or `user`