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

Shared - Refactor projects in local storage #246

Closed
4 of 5 tasks
Joery-M opened this issue Sep 26, 2024 · 0 comments · Fixed by #270
Closed
4 of 5 tasks

Shared - Refactor projects in local storage #246

Joery-M opened this issue Sep 26, 2024 · 0 comments · Fixed by #270
Labels
refactor Overhaul how a part of the application works scope: Shared Will affect packages/shared

Comments

@Joery-M
Copy link
Owner

Joery-M commented Sep 26, 2024

Project definition

This issue explains what 'projects' represent in the application.

A project is a collection of Media items (#245) and plugins.

Projects themselves should be light-weight, meaning, there should be no consequences for making 1000 projects.

File tree

A project needs to store a file tree to be able to store media items in user-created directories.

Each path segment is a UUID, which allows for easy renaming of folders.

interface ProjectTree {
    entries: {
        [path: string]: TreeItem | ProjectTree;
    };
    name: string;
}

/**
 * This reference is specifically for storage, in the implementation, a tree item should be a media item
 */
interface TreeItem {
    mediaID: string;
}

Storage reference

A project can be stored in IndexedDB using the following information as a base:

Future considerations: Projects should also have the ability to store extra metadata about themselves.


Requirements for this issue:

@Joery-M Joery-M added scope: Shared Will affect packages/shared refactor Overhaul how a part of the application works labels Sep 26, 2024
@Joery-M Joery-M added this to the Setup and structure milestone Sep 26, 2024
@Joery-M Joery-M changed the title Refactor projects in local storage Shared - Refactor projects in local storage Sep 26, 2024
@Joery-M Joery-M linked a pull request Oct 24, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Overhaul how a part of the application works scope: Shared Will affect packages/shared
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant