kffl / bsdetector-client Goto Github PK

Related backend issue:

kffl/bsdetector-server#9

Description

The client app should allow the user to analyze a public GitHub repo. The user should provide username and repository name.

Acceptance criteria

• The user can perform analysis of a specified public GitHub repo
• An error message is presented to a user if repository fetching failed

Sometimes, just the name of a given smell and it's short description may be insufficient for the user to resolve it. Let's add a knowledge base that would describe every code smell.

• Each detected smell should have "Learn more" button that would redirect user to a specific page in knowledge base
• Knowledge base should be a separate view with navigation listing all possible smells
• Knowledge base entries should be stored in fronted repo as static markdown files and loaded dynamically

@newt0npk commented on Thu Mar 26 2020

Create landing page

• It should contain our names, project structure and description
• It should lead to main screen

Related backend issue:

none

Description

Design and use app logo.

Acceptance criteria

• App favicon should be set to the new logo
• App branding should follow Material Design guidelines

Description

Improve code snippets look & feel.

Acceptance criteria

• Code snippets should have line numbers
• Exact location of a code smell should be highlighted
• Code snippets should have syntax highlighting
• Line numbers should not alter code indentation

We shouldn't force the users to paste their code - some of them may want to select a file from their local filesystem for upload.

• Code analysis view should allow users to select a file for upload from their filesystem via file explorer
• It should also allow users to drag-n-drop a file from desktop or a folder
• Allow to add and analyze multiple files

Description

Statistics should cover at least: number of analyzed lines, number of detected smells, number of analyzed files, number of analyzed repos. They should be presented as text.
They should be shown in several places:

• Landing page - sum of: analyzed lines, detected smells, analyzed files, analyzed repos. This data should be fetched from server.
• File / uploaded code expansion panels - number of: analyzed lines, detected smells
• Files expansion panels (Code upload, Repo analysis) - number of analyzed files, sum of analyzed lines, sum of detected smells

Description

Use code editor component to improve user experience during writing code in application.

Acceptance criteria

• auto-completion
• syntax highlighting
• limit code size, so the response will be shorter than 20s

Create a basic form that would connect to (currently partially mock) API endpoints and show the response.

• It should allow user to paste in code
• It should send a request to backend and handle potential errors
• It should list detected code smells