Skip to content

High performance self-hosted photo and video management solution.

fix(docs): instructions on how to use local immich ui (#27813)

Yaros79c392ceba39
diff --git a/docker/docker-compose.dev.yml b/docker/docker-compose.dev.yml
index bcfb86a2aa..434500b835 100644
--- a/docker/docker-compose.dev.yml
+++ b/docker/docker-compose.dev.yml
@@ -20,6 +20,7 @@ services:
- /tmp
volumes:
- ..:/usr/src/app
+ # - ../../ui:/usr/src/ui
- pnpm_cache:/buildcache/pnpm_cache
- server_node_modules:/usr/src/app/server/node_modules
- web_node_modules:/usr/src/app/web/node_modules
diff --git a/docs/docs/developer/setup.md b/docs/docs/developer/setup.md
index 4bbf71dd89..abdb3befbe 100644
--- a/docs/docs/developer/setup.md
+++ b/docs/docs/developer/setup.md
@@ -80,9 +80,9 @@ To see local changes to `@immich/ui` in Immich, do the following:
1. Install `@immich/ui` as a sibling to `immich/`, for example `/home/user/immich` and `/home/user/ui`
2. Build the `@immich/ui` project via `pnpm run build`
-3. Uncomment the corresponding volume in web service of the `docker/docker-compose.dev.yaml` file (`../../ui:/usr/ui`)
-4. Uncomment the corresponding alias in the `web/vite.config.js` file (`'@immich/ui': path.resolve(\_\_dirname, '../../ui')`)
-5. Uncomment the import statement in `web/src/app.css` file `@import '/usr/ui/dist/theme/default.css';` and comment out `@import '@immich/ui/theme/default.css';`
+3. Uncomment the corresponding volume in web service of the `docker/docker-compose.dev.yml` file (`../../ui:/usr/src/ui`)
+4. Uncomment the corresponding alias in the `web/vite.config.ts` file (`'@immich/ui': path.resolve(\_\_dirname, '../../ui/packages/ui')`)
+5. Uncomment the import statement in `web/src/app.css` file `@import '../../../ui/packages/ui/dist/theme/default.css';` and comment out `@import '@immich/ui/theme/default.css';`
6. Start up the stack via `make dev`
7. After making changes in `@immich/ui`, rebuild it (`pnpm run build`)
diff --git a/web/src/app.css b/web/src/app.css
index 4afc13ea0a..0a0187f9fd 100644
--- a/web/src/app.css
+++ b/web/src/app.css
@@ -1,7 +1,7 @@
@import 'tailwindcss';
@import '@immich/ui/theme/default.css';
@source "../node_modules/@immich/ui";
-/* @import '/usr/ui/dist/theme/default.css'; */
+/* @import '../../../ui/packages/ui/dist/theme/default.css'; */
@utility immich-form-input {
@apply bg-gray-100 ring-1 ring-gray-200 transition outline-none focus-within:ring-1 disabled:cursor-not-allowed dark:bg-gray-800 dark:ring-neutral-900 flex w-full items-center rounded-lg disabled:bg-gray-300 disabled:text-dark dark:disabled:bg-gray-900 dark:disabled:text-gray-200 flex-1 py-2.5 text-base pl-4 pr-4;
diff --git a/web/vite.config.ts b/web/vite.config.ts
index a30f2b4103..2cda67c3c0 100644
--- a/web/vite.config.ts
+++ b/web/vite.config.ts
@@ -29,7 +29,7 @@ export default defineConfig({
'xmlhttprequest-ssl': './node_modules/engine.io-client/lib/xmlhttprequest.js',
// eslint-disable-next-line unicorn/prefer-module
'@test-data': path.resolve(__dirname, './src/test-data'),
- // '@immich/ui': path.resolve(__dirname, '../../ui'),
+ // '@immich/ui': path.resolve(__dirname, '../../ui/packages/ui'),
},
},
server: {