docs: add instructions for custom theme
This commit is contained in:
parent
c4e23c67ab
commit
0efd9237f6
1 changed files with 18 additions and 3 deletions
21
README.md
21
README.md
|
|
@ -34,7 +34,7 @@ pnpm dev --webpack
|
||||||
> [!NOTE]
|
> [!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
|
> 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)
|
[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.
|
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!
|
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
|
#### Troubleshooting
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue