---
# System prepended metadata

title: '**Backlog**'

---

# **Backlog** 

## Stakeholders
- Application user: Any person that is able to use the client application.
- Application administrator: The person who has access to the server application, which the clients connect to.
- Developers: members of the OOPP team who contribute to the project and are assessed for this.
- Head TA's and lecturers: they are responsible for setting up the GitLab repository, giving instructions and grading the developers.
- The university: it hosts the GitLab repositories.

## Terminology:
- Board: it is the interface that a user can read and possibly edit
- Card: a single object that has text attributes and can be moved around the board
- List: a collection of cards that belong to a certain category, e.g. TODO or Planning
- Nested task list: tasks that can be checked and unchecked located in a card
- Tag: a category that can be added to a card
- Overview (of a board): the positions and attributes of the cards, lists and tags visible to the user
- Client - the client application which connects to the server application and to which the users have access to
- Active Board (related to the Multi-Board Epic): the board that is currently shown in the Overview and thus the only board which the user can edit right now
- Switch (to a board): change the Active Board to another board
- List of Boards/Board List (related to the Multi-Board Epic): a list of all of the boards that a user has access to. This list must be able to be opened from the Overview of any board and can be used to swtich to any of the boards on the list.

## Functional Requirements

- ### Basic Features
    - As a user I want to be able to create cards
        - must have an add card button for each list
        - after pressing the button the user must be asked about the card's title
        - should have a delete card button in the pop-up
        - must have an edit button in the pop-up
    - As a user I want to be able to edit cards
        - it should be possible to edit the title of the card from the overview
    - As a user, I want to be able to delete cards
        - it must be possible to delete cards from the overview
    - As a user, I want to move cards
        - it must be possible to move cards between lists 
        - it must be possible to move cards within a list
    - As a user I want to be able to create lists
        - there must be button through which a new list can be created
        - it must be possible to fill out the list name when creating it
    - As a user I want to be able to edit lists
        - it must be possible to rename a list from the overview
    - As a user I want to be able to delete lists
        - it must be possible to delete a list from the overview
    - As a user I want to be able to move lists
        - it must be possible to move lists around the board (before/after another list(s))
    - As a user I want to work on a board with other users
        - it must be possible to work on the same board with other users at the same time
        
- ### Multi-Board
    - As a user I want to create more boards, so I can better better organize my tasks and so that not everyone works on the same board
        - created boards must appear in my List of Boards
        - creating a board should automatically switch to that board
        - there could be a "Welcome" page that shows up if you don't have any boards in your Board List which provides the user with an option to create a new board
        - when a user clicks the "Create a Board" button, a pop-up window requesting the board name must be shown
    - As a user I want to have convenient access to all of my boards
      - any boards that a user creates or joins must be added to their local list of boards
      - a user must then at any point be able to chose a board from that list and switch to it
      - that local list of boards should be persistent for a user even if they restart their client application
    - As an admin I want to be able to delete boards
        - it must not be possible to join that board
        - the code of the board must be invalidated thereafter
   - As a user, I want to be able to collaborate with other users on the same board
        - the overview of the board that I am working on with others must synchronize when someone makes a change
        - the app should not break/crash when two users make a change to the same part of a board at the same time
        - any changes made to a board by any user must be saved to the server so they can be retreived when a user opens that board on their client app
        - those changes must not be lost when the server restarts
    - As a user, I want to share my board with other users and join other users' boards
        - for every board that I have access to there must be a code that I can view, so I can send it to others, in order for them to have access to that board as well
        - when a user enters that board code into their client app, the board must be added to their local list of boards and they must be able to edit any part of the board, or even delete it

- ### Additional Card Details
    - As a user I want to add details to cards through a pop-up
        - the pop-up should ask for the card description
        - the pop-up should ask for tags that the card should have
    - As a user I want to be able to view additional card components
        - should have a pop-up that displays information about the card
        - the information must contain the card title
        - the information should contain the card description
        - the information should contain the card's tags
        - the information should contain the nested task list
    - As a user I want to edit the cards' details through a pop-up
        - through the edit button in the view card window a new pop-up must appear for editing
        - it must be possible to edit the title of the card
        - it should be possible to edit card details - description, nested lists, tags
    - As a user I want to delete a card through the pop-up
        - it should be possible to delete cards from the view card window
        
- ### Tag Support
    - As a user I want to be able to create tags
        - it should be possible to create a new tag, which is automatically added to the card 
    - As a user I want to be able to add and remove tags from cards
       - it should be possible to add an existing tag to a card 
       - it should be possible to remove a tag from a card
    - As a user I want to be able to manage tags for the whole board
        - it could be possible to add and delete a tag in the board settings

- ### Customization (Background, Tag colors)
    - As a user I want to be able to edit boards
        - it could be possible to change the board's name
        - it should be possible to customize the board's visual appearance (background colors, visible key shortcuts) through a board settings page/pop-up

- ### Keyboard shortcuts
    - As a user I want to be able to manage the board using shortcuts
        - it should be possible to add cards and lists using shortcuts
        - it could be possible to add tags using shortcuts
        - it could be possible to move cards using shortcuts
        - it could be possible to create and join boards using shortcuts
    
- ### Protected Boards
    - As a user, I should be able to determine what kind of access to give to other users when I share a board with them
        - there should also be a second kind of code which provides only "read" permissions for the board, which allows a user to see any part of the board, but does not allow them to edit anything on there
        - if a user has only entered a read code for a board they should be able to view that read code, so they can share it with others, but they should not have access to a read/write code
        - if a user has read persmissions to a board and they enter a read/write code for that same board, they should automatically be "upgraded" to have read/write privilages to that board (the board should not show up twice in their list of boards)
        - if a user has read/write persission for a board they should be able to view (and thus be able to share) both the read code and the read/write code for that board

- ### Manage Server
    - As an administrator, I want to be able to restart the server
        - there should be some sort of GUI or CLI that allows you to restart the server and see the codes of all boards, which also means that the admin will be able to modify any boards on the server

## Non-functional Requirements

### Product
- A database must be used to store the server's data
- The client must connect to the server in order to access a board
- The server must be able to server multiple clients simultaneously
- Updates to the overview should appear in less than three seconds
- The application should run in an environment with at least 2GB of available RAM
- The user interface must be easy to navigate and understand

### Organisational
- Java SE 19 should be used
- JavaFX and Spring Boot must be used
- Libraries with critical vulnerabilities must not be used
- Interfaces must be documented using JavaDoc

### External
- The application should run successfully and meet all requirements regardless of operating system and architecture
- A license can be used
