Projects

[Joery-M]

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

A project is a collection of Media (#286) and Plugins (#292).

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 final API, a tree item should be a media item
 */
interface TreeItem {
    mediaID: string;
}

Warning

This does not represent the final API

Storage reference

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

• ID: UUID
• Name: string
• Created: ISO-DateTime
• Modified: ISO-DateTime
• Media: An array of ID's referencing media (Media #286).

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