Attach a ReadMe - Githubissues

beergode / tech-thrive-catalyst

New Ideas are Born in a High Stack Oasis

3 stars 0 forks source link

Attach a ReadMe #4

Closed berkayerten closed 3 months ago

berkayerten commented 4 months ago

Mention tech stack used
Mention architecture used
Describe purpose shortly
Describe project(s)
Include how to setup locally
Include docker setup

mehmetugurakpinar commented 3 months ago

I've added a README to the project, but I didn't include any information about Docker. Could you take a look and let me know if you see any gaps or areas that need improvement? @berkayerten @gokhandegerli

berkayerten commented 3 months ago

Hi @mehmetugurakpinar - it's great you started this ❤️ . Could you please also mention,

Features: Shall we mention that this tool can also be used for public surveying besides private decision making?
tech stack: We can also mention Java is of version 21, and Spring 3.2.X, MongoDB.
Architecture: DDD/ Hexagonal
To run project with Docker you can add:
- cd decision-maker/infra
- docker compose up -d

mehmetugurakpinar commented 3 months ago

Thanks @berkayerten, I updated the ReadMe. I will close this issue. Feel free to change/add to the document if you have new ideas. @berkayerten @gokhandegerli

mehmetugurakpinar commented 3 months ago

Done but open to improve.