enso/app/README.md
somebody1234 ebf4cd5c1f
Inline modules in app/ide-desktop/ (#10305)
- Remove unnecessary modules
- Remove `ts-plugin-namespace-auto-import` as it was a workaround to use the non-conventional `import *` convention
- Remove `esbuild-plugin-copy-directories` as it is unuse
- Inline modules that are only ever used once
- Inline `project-manager-shim` into `gui2` - it is only used during `gui2`'s dev mode
- Inline `content-config` into `client`
- Flatten `app/ide-desktop/lib/` to `app/ide-desktop/`
- Flatten `app/ide-desktop/lib/dashboard/` to `app/dashboard/`

# Important Notes
- As mentioned above, all remaining modules have been moved up from `app/ide-desktop/lib/` to `app/ide-desktop/`. It's not ideal but I'd rather hold off on moving them anywhere else before we have a consensus on what should go where.
- (That is to say, this may not be the final directory structure - but I figure it's fine to get *something* done so that hopefully the rest of the restructuring is simpler.)
2024-07-17 09:10:42 +00:00

24 lines
1.0 KiB
Markdown

# Desktop app
This folder contains projects related to the desktop app.
## Folder structure
Refer to the `README.md` in each individual module (if it exists) for the
internal folder structure of the module.
- `assets/`: Icons and images used by other modules. Currently these are only
used by `dashboard/`.
- `client/`: The code for the Electron desktop app.
- `common/`: Utility functions required by multiple other modules.
- `content/`: The entry point for the GUI1 web app. This is the main page for
the desktop app.
- `content-config/`: The statically-typed configuration object for `content/`.
- [`dashboard/`](./lib/dashboard/README.md): The dashboard, used to manage
projects. It launches the GUI (located in `content/` for GUI1, or `/app/gui2/`
for GUI2) when a project is opened.
- `icons/`: Generates the logo for the app.
- `ts-plugin-namespace-auto-import/`: (WIP) A TypeScript plugin to change
auto-import to use `import * as moduleName` rather than `import {}`.
- `types/`: Miscellaneous types used by multiple modules.