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.

Sign up for GitHub

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

Jump to bottom

Developer documentation #163

Open
18 of 22 tasks
aletutto opened this issue Apr 8, 2020 · 0 comments
Open
18 of 22 tasks

Developer documentation #163

aletutto opened this issue Apr 8, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@aletutto
Copy link
Collaborator

aletutto commented Apr 8, 2020 •
edited by StephanHagge
Loading

General

  • Usage of technology
  • Architecture overview

Frontend

  • Generated client via openAPI
    • New generation of client if interface changes
  • Theming
  • Monaco Editor
  • Overview of components
  • Build config
  • Syntax highlighting features
  • Tokenizer
  • Linting

Backend

  • Description
  • API-Documentation
  • Data model
  • Architecture & architectural decisions
    • Picture of architecture and general description
    • Package structure
    • Schema as an own attribute
    • DTO
    • Database initialization
    • Reset-Endpoint
  • Unit- & Integration-Tests
@aletutto aletutto added the documentation Improvements or additions to documentation label Apr 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@aletutto