From 0efd9237f6705111b9a8f811983582becd2b4471 Mon Sep 17 00:00:00 2001 From: nxtkofi Date: Sat, 28 Mar 2026 12:58:16 +0100 Subject: [PATCH] docs: add instructions for custom theme --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d15b14a..73bf4e5 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ pnpm dev --webpack > [!NOTE] > As of Next.js@16.2.1 turbopack is broken ant it spikes CPU usage by 900% and 8-9GiB of RAM usage, thus why we use webpack. Wait for 16.3.0 to migrate to turbopack -### Convex +### Convex setup [Source of truth](https://github.com/get-convex/convex-backend/blob/main/self-hosted/README.md) @@ -128,9 +128,24 @@ self-hosted-convex|010... ``` 4. Now Your base is ready. Go to .env.local and finish setting up the connection. -5. Run `npm install` (only if Your image is latest, else use a proper version) +5. Run `pnpm install` (only if Your hosted Convex image is latest, else use a proper version) 6. After that You can run `npx convex dev` and You should be ready to go! -7. Time to pick a theme! Go to [shadcn/create](https://ui.shadcn.com/create), create a theme, and simply use the received command to init this theme in Your project! + +### Frontend setup + +1. Time to pick a theme! Go to [shadcn/create](https://ui.shadcn.com/create), create a theme, and simply use the received command to init this theme in Your project! + +2. Replace `aliases` section in `components.json`. Then folders accordingly. + +``` +"aliases": { + "components": "@/src/components", + "utils": "@/src/lib/utils", + "ui": "@/src/components/shadcn", + "lib": "@/src/lib", + "hooks": "@/src/hooks" +}, +``` #### Troubleshooting