Skip to content

Commit 6486ceb

Browse files
authored
docs(README): update
1 parent b02c8e4 commit 6486ceb

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This is a base monorepo starter template to kick-start your beautifully organize
3737

3838
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.
3939
* 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`.
4141

4242
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)
4343

@@ -94,7 +94,7 @@ A super efficient and powerful, yet friendly LLM Chat system, featuring:
9494
* 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.
9595

9696
`*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.
9898

9999
### Apps and Libraries
100100

@@ -135,14 +135,14 @@ To build all apps and packages, run the following command:
135135

136136
### Develop
137137

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).
139139

140140
To develop all apps and packages, run the following command:
141141
`pnpm run dev`
142142

143143
For local development environment variables / secrets, create a copy of `.env.dev` to `.env.dev.local`.
144144

145-
#### Wrangler / Cloudflare Workers
145+
#### Wrangler / Cloudflare Workers (Local dev via workerd)
146146

147147
Guide to setup local development for Cloudflare `workerd` runtime testing:
148148
* (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
173173

174174
#### Dev with SSL
175175

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.
177177

178-
### Remote Caching
178+
### Turborepo Remote Caching
179179

180180
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.
181181

@@ -195,11 +195,17 @@ npx turbo link
195195

196196
## Useful Links
197197

198-
Learn more about the power of Turborepo:
198+
Learn more about the tech of the repo:
199+
200+
### Turborepo
199201

200202
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
201203
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
202204
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
203205
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
204206
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
205207
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
208+
209+
### grammY
210+
211+
[https://grammy.dev](https://grammy.dev)

0 commit comments

Comments
 (0)