You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ This is a base monorepo starter template to kick-start your beautifully organize
37
37
38
38
Out-of-the-box with the included apps, we have a fullstack project: with a `frontend` Nuxt 4 app, a main `backend` using Hono, and a `backend-convex` Convex app.
39
39
* General APIs, such as authentication, are handled by the main `backend`, which is designed to be serverless-compatible and can be deployed anywhere, allowing for the best possible latency, performance, and cost, according to your needs.
40
-
*`backend-convex` is a modular, add-in `backend`, utilized to power components like `AI Chat`.
40
+
*`backend-convex` is an optional, modular/add-in backend, utilized to power components like `AI Chat`.
41
41
42
42
It is recommended to use an AI Agent ([`Roo Code`](https://github.com/RooVetGit/Roo-Code) recommended) to help you setup the monorepo according to your needs, see [Utilities](#utilities)
43
43
@@ -94,7 +94,7 @@ A super efficient and powerful, yet friendly LLM Chat system, featuring:
94
94
* Any AI provider that is compatible with `@ai-sdk` interface can be added in a few words of code, I just don't want to bloat the UI by adding all of them.
95
95
96
96
`*1`: currently the "stream" received when resuming or for other real-time users in the same thread is implemented via a custom polling mechanism, and not SSE. it is intentionally chosed to be this way for more minimal infrastructure setup and wider hosting support, so smaller user groups can host their own version easily, it is still very performant and efficient.
97
-
* There is boilerplate code for SSE resume support, you can simply add a pub-sub to the backend and switch to using SSE resume in `ChatInterface`.
97
+
* There is boilerplate code for SSE resume support, you can simply add a pub-sub to the backend and switch to using SSE resume in `ChatInterface` component.
98
98
99
99
### Apps and Libraries
100
100
@@ -135,14 +135,14 @@ To build all apps and packages, run the following command:
135
135
136
136
### Develop
137
137
138
-
If you just want a quick check out, without having to set up anything, you can use `pnpm run dev:noConvex`, this will skips `backend-convex` and which is the only component that have initial set ups, though this of course means related features are disabled.
138
+
If you just want a quick check out, without having to set up anything, you can use `pnpm run dev:noConvex`, this will skips `backend-convex`, which is the only component that have initial set ups, though, this of course means related features are disabled (AI Chat).
139
139
140
140
To develop all apps and packages, run the following command:
141
141
`pnpm run dev`
142
142
143
143
For local development environment variables / secrets, create a copy of `.env.dev` to `.env.dev.local`.
144
144
145
-
#### Wrangler / Cloudflare Workers
145
+
#### Wrangler / Cloudflare Workers (Local dev via workerd)
146
146
147
147
Guide to setup local development for Cloudflare `workerd` runtime testing:
148
148
* (Optional) Run the convex dev server if you use convex.
@@ -173,9 +173,9 @@ Imports should not be separated by empty lines, and should be sorted automatical
173
173
174
174
#### Dev with SSL
175
175
176
-
The project comes with a `localcert` SSL at `locals/common/dev` to enable HTTPS for local development, generated with [mkcert](https://github.com/FiloSottile/mkcert), you can install mkcert, generate your own certificate and replace it, or install the `localcert.crt` to your trusted CA to remove the untrusted SSL warning.
176
+
The project comes with a `localcert` SSL at `locals/common/dev` to enable HTTPS for local development (because some 3rd-party services require local dev to have HTTPS, so I enable it by default), generated with [mkcert](https://github.com/FiloSottile/mkcert), you can install mkcert, generate your own certificate and replace it, or install the `localcert.crt` to your trusted CA to remove the untrusted SSL warning.
177
177
178
-
### Remote Caching
178
+
### Turborepo Remote Caching
179
179
180
180
Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
0 commit comments