Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #44

Open
Alathreon opened this issue Jul 30, 2024 · 0 comments · May be fixed by #48
Open

Improve readme #44

Alathreon opened this issue Jul 30, 2024 · 0 comments · May be fixed by #48
Assignees
Labels
enhancement New feature or request

Comments

@Alathreon
Copy link
Contributor

Alathreon commented Jul 30, 2024

  • Improve the general text.
  • Explain for the wrapper that running it in local is only usefull if the dev needs to work on it.
  • Explain why there are two ways to run the API and parallel to TJ-Bot (+specify why it's important to test both because the API needs to do docker calls from docker).
  • Add advised knowledge part at the start mentioning java, gradle, docker and spring.
  • Add a diagram for the whole setup and maybe diagrams for the running alternatives.
@Alathreon Alathreon added the enhancement New feature or request label Jul 30, 2024
@Alathreon Alathreon self-assigned this Aug 1, 2024
@Alathreon Alathreon linked a pull request Aug 1, 2024 that will close this issue
5 tasks
@Alathreon Alathreon linked a pull request Aug 1, 2024 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant