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: docs/content/docs/1.getting-started/1.index.md
+5-4
Original file line number
Diff line number
Diff line change
@@ -22,13 +22,14 @@ Each storage utils is auto-imported and ready to be used in your [Nuxt's server
22
22
NuxtHub comes with a powerful proxy system to connect to your project's resources from your local environment, allowing you to work with your remote storage as if it was local.
23
23
::
24
24
25
-
## Modules
25
+
## Packages
26
26
27
27
We plan to provide a complete backend experience for Nuxt apps through various `@nuxthub` modules.
28
28
29
-
-[`@nuxthub/core`](https://github.com/nuxt-hub/core): Main module to provide storage features
30
-
-`@nuxthub/auth`: Authentication module for user management
31
-
-`@nuxthub/analytics`: Analytics module to track events within your applicaiton and API
29
+
-[`@nuxthub/core`](https://github.com/nuxt-hub/core): Main package to provide storage features
30
+
-`@nuxthub/auth`: Add authentication for user management (soon)
31
+
-`@nuxthub/email`: Send transactional emails to your users (soon)
32
+
-`@nuxthub/analytics`: Understand your traffic and track events within your application and API (soon)
Copy file name to clipboardexpand all lines: docs/content/docs/1.getting-started/2.installation.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
2
title: Installation
3
-
description: Add NuxtHub core module to your Nuxt project.
3
+
description: Add NuxtHub to your Nuxt project.
4
4
---
5
5
6
6
7
7
## Setup
8
8
9
-
1. Install the NuxtHub module to your project:
9
+
1. Install the NuxtHub package to your project:
10
10
11
11
::code-group
12
12
@@ -50,18 +50,18 @@ bun add --dev @nuxthub/core
50
50
51
51
::
52
52
53
-
3. Add `@nuxthub/core` to your `modules` section in your `nuxt.config`:
53
+
3. Add `@nuxthub/core` to your `extends` section in your `nuxt.config`:
54
54
55
55
```ts [nuxt.config.ts]
56
56
exportdefaultdefineNuxtConfig({
57
-
modules: ['@nuxthub/core']
57
+
extends: ['@nuxthub/core']
58
58
})
59
59
```
60
60
61
-
That's it! You can now use the NuxtHub module in your Nuxt project.
61
+
That's it! You can now use NuxtHub features in your Nuxt project.
62
62
63
63
::callout
64
-
The module will create a `.data/hub` directory in your project root, which contains the necessary configuration files and resources for the module to work. It will also add it to the `.gitignore` file to avoid committing it to your repository.
64
+
NuxtHub will create a `.data/hub` directory in your project root, which contains the necessary configuration files and resources for the features to work. It will also add it to the `.gitignore` file to avoid committing it to your repository.
65
65
::
66
66
67
67
## Options
@@ -70,7 +70,7 @@ Configure options in your `nuxt.config.ts` as such:
The module will use the remote storage from your deployed project **as long as you are logged in with the [NuxtHub CLI](https://github.com/nuxt-hub/cli) and the local project is linked to a NuxtHub project**.
52
+
Nuxt will use the remote storage from your deployed project **as long as you are logged in with the [NuxtHub CLI](https://github.com/nuxt-hub/cli) and the local project is linked to a NuxtHub project**.
53
53
54
54
## Self-hosted
55
55
@@ -75,22 +75,20 @@ Once the deployment is done, NuxtHub should be ready to use in your deployed pro
75
75
76
76
### Remote Storage
77
77
78
-
To enable remote storage in your self-hosted project, the module requires a secret to access it.
78
+
To enable remote storage in your self-hosted project, you need to create a secret key.
79
79
80
-
1. Set the `NUXT_HUB_PROJECT_SECRET` environment variable in your Cloudflare Pages project settings and retry the last deployment to apply the changes.
80
+
1. Set the `NUXT_HUB_PROJECT_SECRET` environment variable in your Cloudflare Pages project settings and retry the last deployment to apply the changes (you can generate a random secret on https://www.uuidgenerator.net/version4)
81
81
2. Set the same `NUXT_HUB_PROJECT_SECRET` and `NUXT_HUB_PROJECT_URL` environment variables in your local project
When restarting your local server, the module will automatically use the remote data from your deployed project as long as the `NUXT_HUB_PROJECT_SECRET` matches the one in your Cloudflare Pages project settings.
89
-
90
88
Then, start your Nuxt project with:
91
89
92
90
```bash [Terminal]
93
91
npx nuxt dev --remote
94
92
```
95
93
96
-
Your development project will now use the remote storage from your deployed project.
94
+
NuxtHub will use the remote data from your deployed project as long as the `NUXT_HUB_PROJECT_SECRET` matches the one in your Cloudflare Pages project settings.
Copy file name to clipboardexpand all lines: docs/content/index.yml
+6-2
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,14 @@
1
-
title: 'NuxtHub'
2
-
description: 'Build full-stack Nuxt apps, with zero configuration.'
1
+
title: 'NuxtHub: Build full-stack Nuxt apps, on the edge.'
2
+
description: 'Access to a Database, Key-Value, and Blob storage with zero configuration. Deploy with confidence on your Cloudflare account and access to your remote storage locally with our secured proxy.'
3
3
navigation: false
4
4
hero:
5
5
title: 'Build full-stack <span class="text-primary">Nuxt apps</span>, on the edge.'
6
6
description: 'Access to a Database, Key-Value, and Blob storage with zero configuration. Deploy with confidence on your Cloudflare account and access to your remote storage locally with our secured proxy.'
0 commit comments