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

Write a design document #5

Closed
vityaman opened this issue Feb 24, 2024 · 2 comments · Fixed by #20
Closed

Write a design document #5

vityaman opened this issue Feb 24, 2024 · 2 comments · Fixed by #20
Labels
docs Improvements or additions to documentation

Comments

@vityaman
Copy link
Member

vityaman commented Feb 24, 2024

Description

After requirements will be fixed, need to make some draft of project architecture to ensure that we can meet all requirements from https://se.ifmo.ru/courses/bl. Also we need to choose technologies for an implementation.

Again, no complex things, keep it simple, but useful.

Output

  • Merged MR with a design document.
@vityaman
Copy link
Member Author

vityaman commented Feb 24, 2024

What is obvious is the usage of Spring Boot and Kotlin. OpenAPI specification can be developed instead of curl scripts. With OpenAPI spec it is easy to setup codegen for controllers and API data transfer objects. Gradle as a build system.

@vityaman vityaman added the docs Improvements or additions to documentation label Feb 24, 2024
@vityaman
Copy link
Member Author

vityaman commented Mar 9, 2024

We have BPMN diagram made for issue #3. It shows the essence of the system, so the design document must target some implementation details like contest system, attached files types, communication protocols, used technologies, project iterations.

@vityaman vityaman linked a pull request Mar 27, 2024 that will close this issue
vityaman added a commit that referenced this issue Mar 28, 2024
vityaman added a commit that referenced this issue Mar 28, 2024
vityaman added a commit that referenced this issue Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant