cosms/cosms-core
1
0
Fork 0
Code Issues 6 Pull requests Projects 1 Releases Packages Wiki Activity Actions

docs(requirements): added requirement and user story documentation (cosms-1) #10

Merged
Mineplay merged 9 commits from docs/1-requirements into main 2025-12-04 13:11:33 -06:00
Conversation 0 Commits 9 Files changed 1 +27 -19
1 changed files with 27 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit bca09f0ff0 - Show all commits

46
docs/requirements.md
View file

@ -50,8 +50,9 @@ By using this format the requirement will be easly retracable to the user story
**Description**: As an user, I want to watch/listen to my media on any device so that I can watch content anywhere.
**Accaptance**
* Given the user is connected to the internet when the user opens cosms then the user should beable to watch/listen to any available media.
* Given that cosms is running when the user select a supported media file to play then playback should start within 5 seconds.
* Given the user is connected to the internet when the user opens cosms then the user should beable to watch/listen to any available media.
* Given that cosms is running when the user select a supported media file to play then playback should start within 5 seconds.
--------------------------------
@ -59,8 +60,9 @@ By using this format the requirement will be easly retracable to the user story
**Description**: As an user, I want to search for content quickly so I can easly find something I want to watch.
**Accaptance**
* Given the user has media on cosms when the user enters a search term then the user should automatically see relevant media based on the metadata.
* Given the user has no media on cosms when the user enters a search term then the user should get a message "No media found".
* Given the user has media on cosms when the user enters a search term then the user should automatically see relevant media based on the metadata.
* Given the user has no media on cosms when the user enters a search term then the user should get a message "No media found".
--------------------------------
@ -68,7 +70,8 @@ By using this format the requirement will be easly retracable to the user story
**Description**: As an user, I want to continue where I left of so I can easly resume playback.
**Accaptance**
* Given the user has watched/listened to part of a media file when the user stops playback and closes the app then the media should continue where the user left it the next time the user starts playing it.
* Given the user has watched/listened to part of a media file when the user stops playback and closes the app then the media should continue where the user left it the next time the user starts playing it.
--------------------------------
@ -76,9 +79,10 @@ By using this format the requirement will be easly retracable to the user story
**Description**: As an user, I want subtitles to display so I can enjoy foreign language content.
**Accaptance**
* Given the user has media files that have subtitles when the user starts playback then the user should be able to select subtitles track.
* Given a subtitle track is selected when the user starts playback then the subtitles should appear in sync with the dialogue.
* Given a language is selected and automatic subtitles is on when the user starts playback with audio in a different language then subtitles should automatically appear.
* Given the user has media files that have subtitles when the user starts playback then the user should be able to select subtitles track.
* Given a subtitle track is selected when the user starts playback then the subtitles should appear in sync with the dialogue.
* Given a language is selected and automatic subtitles is on when the user starts playback with audio in a different language then subtitles should automatically appear.
--------------------------------
@ -86,8 +90,9 @@ By using this format the requirement will be easly retracable to the user story
**Description**: As an administrator, I want to upload and organize media so I can add new content for users to watch.
**Accaptance**
* Given the administrator logged in as administrator when the administrator uploads a media file then the system should automatically add it to the media list and categirize it.
* Given new media has been added when the administrator or user views the library then the media should appear.
* Given the administrator logged in as administrator when the administrator uploads a media file then the system should automatically add it to the media list and categirize it.
* Given new media has been added when the administrator or user views the library then the media should appear.
-------------------------------
@ -95,10 +100,11 @@ By using this format the requirement will be easly retracable to the user story
**Description**: As an administrator, I want to manage user accounts so I can control who has access to the media station.
**Accaptance**
* Given the administrator is logged in as administrator when the administrator creates a new user then the new user should appear in the list and beable to login.
* Given the administrator is logged in as administrator when the administrator disables or deletes an user then the user should not beable to login anymore.
* Given the administrator is logged in as administrator when the administrator sets the access rights of an user then they should only beable to see media they are allowed to see.
* Given the administrator is logged in as administrator when the administrator sets the access rights of an user then they should only beable to make changes to media they are allowed to.
* Given the administrator is logged in as administrator when the administrator creates a new user then the new user should appear in the list and beable to login.
* Given the administrator is logged in as administrator when the administrator disables or deletes an user then the user should not beable to login anymore.
* Given the administrator is logged in as administrator when the administrator sets the access rights of an user then they should only beable to see media they are allowed to see.
* Given the administrator is logged in as administrator when the administrator sets the access rights of an user then they should only beable to make changes to media they are allowed to.
------------------------------
@ -106,8 +112,9 @@ By using this format the requirement will be easly retracable to the user story
**Description**: As an administrator, I want automatic library scanning so I do not have to manually add new content.
**Accaptance**
* Given scanning is enabled when new media is added to the watched folder then the new media should be visible in cosms.
* Given manual scanning is triggered when the scan is complete then the new media should be visible in cosms.
* Given scanning is enabled when new media is added to the watched folder then the new media should be visible in cosms.
* Given manual scanning is triggered when the scan is complete then the new media should be visible in cosms.
------------------------------
@ -115,9 +122,10 @@ By using this format the requirement will be easly retracable to the user story
**Description**: As an user, I want to download media localy so I can watch it anywhere even without internet.
**Accaptance**
* Given the user is connected to the internet when the user downloads the media then it should be stored localy on there device.
* Given the user has media downloaded when the user has not internet then the user should be able to watch the downloaded media.
* Given the user has media downloaded when the user deletes the download files then the files should not be stored anymore on there device.
* Given the user is connected to the internet when the user downloads the media then it should be stored localy on there device.
* Given the user has media downloaded when the user has not internet then the user should be able to watch the downloaded media.
* Given the user has media downloaded when the user deletes the download files then the files should not be stored anymore on there device.
### Requirements