Skip to content

feat: vectorize #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 64 commits into from
Oct 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
56fdea3
feat: support specifying account id to wrangler
RihanArfan Jun 18, 2024
94b30b7
feat: vectorize
RihanArfan Jun 19, 2024
544cd0f
fix: typo in error message
RihanArfan Jun 20, 2024
16a363a
feat: vectorize via proxy
RihanArfan Jun 20, 2024
6847c0d
feat: include vectorize in build hook
RihanArfan Jun 20, 2024
6b7813a
feat: include vectorize and ai in manifest
RihanArfan Jun 25, 2024
1b1a2c7
fix: put server routes in correct directory
RihanArfan Jun 25, 2024
aeb96f0
[autofix.ci] apply automated fixes
autofix-ci[bot] Jun 25, 2024
79a488e
fix: remove unused param from vectorize.getByIds proxy wrapper
RihanArfan Jun 26, 2024
b890979
feat: match namespace length limits in proxy wrapper validator
RihanArfan Jun 26, 2024
4319168
Merge branch 'main' into feat/vectorize
RihanArfan Aug 15, 2024
4214d42
Merge branch 'main' into feat/vectorize
atinux Aug 21, 2024
f01e5e4
Merge remote-tracking branch 'upstream/main' into feat/vectorize
RihanArfan Aug 30, 2024
844b009
fix: make dev:prepare work on windows
RihanArfan Aug 31, 2024
959ee2f
refactor: remove account id
RihanArfan Aug 31, 2024
0c6adcc
fix: use new vectorize types
RihanArfan Aug 31, 2024
41a96a8
Merge branch 'nuxt-hub:main' into feat/vectorize
RihanArfan Aug 31, 2024
5b49da0
Merge remote-tracking branch 'upstream/main' into feat/vectorize
RihanArfan Sep 17, 2024
1b1563a
feat: support multiple vectorize indexes and metadata indexes
RihanArfan Sep 17, 2024
943c479
fix: don't include vectorize in generated wrangler file
RihanArfan Sep 17, 2024
65a6612
feat: support multiple indexes on remote proxy
RihanArfan Sep 17, 2024
8f7edc7
feat: use vectorize v2 returnMetadata options
RihanArfan Sep 17, 2024
76c4b5c
[autofix.ci] apply automated fixes
autofix-ci[bot] Sep 17, 2024
e997b26
[autofix.ci] apply automated fixes (attempt 2/3)
autofix-ci[bot] Sep 17, 2024
c34e54f
[autofix.ci] apply automated fixes (attempt 3/3)
autofix-ci[bot] Sep 17, 2024
d12853b
fix: support multiple bindings syntax in manifest check
RihanArfan Sep 17, 2024
77070fd
Merge branch 'feat/vectorize' of https://github.com/RihanArfan/nuxt-h…
RihanArfan Sep 17, 2024
5bd8b5f
fix: correct case styles
RihanArfan Sep 19, 2024
c25c178
refactor: simplify type
RihanArfan Sep 19, 2024
311bee7
fix: make metadataIndexes optional
RihanArfan Sep 19, 2024
debceb9
feat: include enabled vectorize indexes in manifest
RihanArfan Sep 20, 2024
95f1678
Merge branch 'main' into feat/vectorize
RihanArfan Sep 24, 2024
0b33a31
fix: only setup vectorize if indexes configured
RihanArfan Sep 24, 2024
76c5afe
revert: "fix: make dev:prepare work on windows"
RihanArfan Sep 24, 2024
388434c
fix: don't directly export type from @cloudflare/workers-types
RihanArfan Sep 24, 2024
ad3098e
refactor: clean up code
RihanArfan Sep 24, 2024
67009ab
Merge branch 'main' into feat/vectorize
RihanArfan Sep 30, 2024
0b07ec2
fix: correctly call function
RihanArfan Sep 30, 2024
cc3bb38
fix: improve regex for index name requirements
RihanArfan Sep 30, 2024
7e704e6
feat: warn if local dev or if remote vectorize config changed
RihanArfan Sep 30, 2024
29e908b
style: capitalisation
RihanArfan Sep 30, 2024
5fdec82
feat: list available remote vectorize indexes
RihanArfan Sep 30, 2024
10ffe49
refactor: vectorize manifest check
RihanArfan Sep 30, 2024
34a67e3
chore: clean up code
RihanArfan Sep 30, 2024
bb30ac1
docs: vectorize
RihanArfan Oct 1, 2024
11c4418
docs: add vectorize pricing
RihanArfan Oct 1, 2024
a5f3068
docs: include free writes on docs
RihanArfan Oct 3, 2024
44100b1
feat: vectorize playground
RihanArfan Oct 3, 2024
dbbfd9d
docs: improve vectorize docs
RihanArfan Oct 4, 2024
ee4b12e
docs: update changelog
RihanArfan Oct 4, 2024
0049cb5
Merge branch 'main' into feat/vectorize
RihanArfan Oct 4, 2024
2a2d0f4
docs: add examples
RihanArfan Oct 4, 2024
743548e
Merge remote-tracking branch 'refs/remotes/origin/feat/vectorize' int…
RihanArfan Oct 4, 2024
74500f6
Merge branch 'main' into feat/vectorize
atinux Oct 4, 2024
1add42b
docs: update
atinux Oct 4, 2024
2649810
docs: remove unnecessary link in comment
RihanArfan Oct 4, 2024
6d38572
docs: small updates
atinux Oct 4, 2024
768c4db
docs: improvements
atinux Oct 4, 2024
b1a25ae
fix: add condition when data is not available yet
atinux Oct 4, 2024
763a676
update doc for self deployment
atinux Oct 4, 2024
c893a21
lint fix
atinux Oct 4, 2024
5544f32
up
atinux Oct 4, 2024
1a22a5e
up
atinux Oct 4, 2024
cf33615
docs: og-image
atinux Oct 5, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/content/0.index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ hero:
light: '/images/landing/hero-light.svg'
dark: '/images/landing/hero-dark.svg'
headline:
label: "`nuxthub preview` command"
to: /changelog/nuxthub-preview
label: "Introducing hubVectorize()"
to: /changelog/hub-vectorize
icon: i-ph-arrow-right
links:
- label: Start reading docs
Expand Down
35 changes: 16 additions & 19 deletions docs/content/1.docs/1.getting-started/3.deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,32 +126,29 @@ That's it! NuxtHub will automatically configure the necessary resources and envi

You can deploy your project on your own Cloudflare account without using the NuxtHub Admin.

For that, you need to create the necessary resources in your Cloudflare account and configure your project to use them:

- One [D1 database](https://dash.cloudflare.com/?to=/:account/workers/d1)
- Two [KV namespaces](https://dash.cloudflare.com/?to=/:account/workers/kv/namespaces) (one for `hubKV()` and one for [server caching](/docs/features/cache))
- One [R2 bucket](https://dash.cloudflare.com/?to=/:account/r2/new)
For that, you need to create the necessary resources in your Cloudflare account and configure your project to use them ([D1](https://dash.cloudflare.com/?to=/:account/workers/d1), [KV](https://dash.cloudflare.com/?to=/:account/workers/kv/namespaces), [R2](https://dash.cloudflare.com/?to=/:account/r2/new), etc.).

::note
You only need to create these resources if you have explicitly enabled them in the Hub Config.
::

Then, create a [Cloudflare Pages project](https://dash.cloudflare.com/?to=/:account/pages/new/provider/github) and link your GitHub or Gitlab repository and choose the Nuxt Framework preset in the build settings.

Once your project is created, open the `Settings -> Functions` tab and set:
- KV namespace bindings
- Set the variable name as `KV` and select your KV namespace created
- Set the variable name as `CACHE` and select your KV namespace for caching created
- R2 bucket bindings
- Set the variable name as `BLOB` and select your R2 bucket created
- D1 database bindings
- Set the variable name as `DB` and select your D1 database created
- AI bindings
- Set the variable name as `AI`
- Browser bindings
- Set the variable name as `BROWSER`
- Compatibility flags
- Add the `nodejs_compat` and `nodejs_als` flags
Once your project is created, open the `Settings` tab and set:
- Runtime > Compatibility flags
- Add the `nodejs_compat` flag
- Bindings
- KV namespace: `KV` and select your KV namespace created
- KV namespace: `CACHE` and select your KV namespace for caching created
- R2 bucket: `BLOB` and select your R2 bucket created
- D1 database: `DB` and select your D1 database created
- AI: `AI`
- Browser: `BROWSER`
- Vectorize: `VECTORIZE_<index name in upper case>` and select your Vectorize index created :br
```bash
# Create the Vectorize index manually using
npx wrangler vectorize create <index-name> --dimensions=<dimensions> --metric=<metric>
```

Go back to the `Deployment` tab and retry the last deployment by clicking on `...` then `Retry deployment`.

Expand Down
Loading