Skip to content

Commit b165577

Browse files
committed
chore: move console to it's own subdomain
1 parent ebe27fa commit b165577

File tree

22 files changed

+433
-156
lines changed

22 files changed

+433
-156
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Build full-stack applications with Nuxt on CloudFlare, with zero configuration.
1313
- Access key-value storage with `useKV()`
1414
- Store files with `useBlob()`
1515

16-
Read more on https://docs.hub.nuxt.com
16+
Read more on https://hub.nuxt.com
1717

1818
## Quick Setup
1919

docs/app.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export default defineAppConfig({
6060
}, {
6161
icon: 'i-simple-icons-nuxtdotjs',
6262
label: 'NuxtHub Console',
63-
to: 'https://hub.nuxt.com',
63+
to: 'https://console.hub.nuxt.com',
6464
target: '_blank',
6565
}]
6666
}

docs/components/Header.vue

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,6 @@ const { header } = useAppConfig()
2222
</template>
2323

2424
<template #right>
25-
<UButton to="https://hub.nuxt.com/?utm_source=nuxthub-docs&utm_medium=header" external icon="i-simple-icons-nuxtdotjs" variant="outline" class="hidden sm:inline-flex">
26-
NuxtHub Console
27-
</UButton>
2825
<UDocsSearchButton v-if="header?.search" :label="null" class="lg:hidden" />
2926

3027
<UColorModeButton v-if="header?.colorMode" />
@@ -36,10 +33,19 @@ const { header } = useAppConfig()
3633
v-bind="{ color: 'gray', variant: 'ghost', ...link }"
3734
/>
3835
</template>
36+
<UButton to="https://console.hub.nuxt.com/?utm_source=nuxthub-docs&utm_medium=header" external icon="i-simple-icons-nuxtdotjs" color="black" class="hidden sm:inline-flex">
37+
NuxtHub Console
38+
</UButton>
3939
</template>
4040

4141
<template #panel>
4242
<UNavigationTree :links="mapContentNavigation(navigation)" />
43+
44+
<div class="flex py-2">
45+
<UButton to="https://console.hub.nuxt.com/?utm_source=nuxthub-docs&utm_medium=header" external icon="i-simple-icons-nuxtdotjs" color="black" block>
46+
NuxtHub Console
47+
</UButton>
48+
</div>
4349
</template>
4450
</UHeader>
4551
</template>

docs/content/1.getting-started/1.index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ NuxtHub provides a set of features to help you build full-stack applications:
1919
Each feature comes with its auto-imported server composable to use in your [Nuxt's server directory](https://nuxt.com/docs/guide/directory-structure/server).
2020

2121
::callout{icon="i-ph-plugs-connected-duotone"}
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 data as if it was local.
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.
2323
::
2424

2525
## Modules
@@ -37,9 +37,9 @@ We are currently in the early stages of development and are looking for feedback
3737

3838
## Console (alpha)
3939

40-
[![nuxt-hub-console](/nuxthub-console.png){class="border rounded dark:border-gray-700 border-gray-200"}](https://hub.nuxt.com)
40+
[![nuxt-hub-console](/nuxthub-console.png){class="border rounded dark:border-gray-700 border-gray-200"}](https://console.hub.nuxt.com)
4141

42-
The [NuxtHub console](https://hub.nuxt.com) is a web based dashboard to manage your NuxtHub apps. It helps you deploy your NuxtHub apps with a single command on your Cloudflare account while provisioning all the necessary resources for you. It abstracts the complexity of managing full-stack Nuxt applications on Cloudflare.
42+
The [NuxtHub console](https://console.hub.nuxt.com) is a web based dashboard to manage your NuxtHub apps. It helps you deploy your NuxtHub apps with a single command on your Cloudflare account while provisioning all the necessary resources for you. It abstracts the complexity of managing full-stack Nuxt applications on Cloudflare.
4343

4444
### Features
4545

@@ -52,5 +52,5 @@ The [NuxtHub console](https://hub.nuxt.com) is a web based dashboard to manage y
5252
- Monitor your application with logs and analytics
5353

5454
::callout
55-
The NuxtHub console is currently in private alpha and is not yet open to the public. We are looking for early adopters to help us shape the platform. If you are interested, please register on [hub.nuxt.com](https://hub.nuxt.com) and tell us what you plan to build with NuxtHub.
55+
The NuxtHub Console is currently in private alpha and is not yet open to the public. We are looking for early adopters to help us shape the platform. If you are interested, please register on [console.hub.nuxt.com](https://console.hub.nuxt.com) and tell us what you plan to build with NuxtHub.
5656
::

docs/content/1.getting-started/2.installation.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,6 @@ The module will create a `.hub` directory in your project root, which contains t
6666

6767
## Options
6868

69-
| Key | Default | Description |
70-
|-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------|
71-
| `remote` | `false` | Allows working with remote data (database, kv, blob) from your deployed project. |
72-
7369
Configure options in your `nuxt.config.ts` as such:
7470

7571
```ts [nuxt.config.ts]
@@ -81,4 +77,14 @@ export default defineNuxtConfig({
8177
})
8278
```
8379

84-
You're all set! Now, let's dive into connecting to your Cloudflare account and deploying it on the Edge.
80+
::field-group
81+
::field{name="remote" type="boolean"}
82+
Default to `false` - Allows working with remote storage (database, kv, blob) from your deployed project. :br
83+
You can set `NUXT_HUB_REMOTE=true` in your `.env` file to enable the remote option.:br
84+
Or use the `--remote` flag when running your Nuxt project locally (e.g. `nuxt dev --remote`).
85+
::
86+
::
87+
88+
::callout
89+
You're all set! Now, let's dive into connecting to your Cloudflare account and [deploying it on the Edge](/getting-started/deploy).
90+
::

docs/content/1.getting-started/3.deploy.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ To deploy your Nuxt application on the Edge, we use Cloudflare Pages. Therefore,
77

88
## NuxtHub Console (alpha)
99

10-
The [NuxtHub Console](https://hub.nuxt.com) is made to simplify your experience with the NuxtHub module, enabling you to effortlessly manage teams and projects, as well as deploy in seconds combined with the NuxtHub CLI.
10+
The [NuxtHub Console](https://console.hub.nuxt.com) is made to simplify your experience with the NuxtHub module, enabling you to effortlessly manage teams and projects, as well as deploy in seconds combined with the NuxtHub CLI.
1111

1212
After linking your Cloudflare account in the console, deploy your project with a single command:
1313

@@ -16,7 +16,7 @@ npx nuxthub deploy
1616
```
1717

1818
The command will:
19-
1. Ensure your are logged in on hub.nuxt.com
19+
1. Ensure your are logged in on console.hub.nuxt.com
2020
2. Link your local project with a NuxtHub project (or create a new one)
2121
3. Build your Nuxt project with the correct preset
2222
4. Deploy it to your Cloudflare account with all the necessary resources
@@ -26,19 +26,30 @@ The command will:
2626
Install the [NuxtHub CLI](https://github.com/nuxt-hub/cli) globally with: `npm i -g nuxthub`.
2727
::
2828

29-
### Remote data
29+
### Remote Storage
3030

31-
In order to use remote data in your local project, update your `nuxt.config.ts`:
31+
Once your project is deployed, you can use the remote storage in your local project.
32+
33+
Start your Nuxt project with:
34+
35+
```bash [Terminal]
36+
npx nuxt dev --remote
37+
```
38+
39+
Your development project will now use the remote storage from your deployed project.
40+
41+
To always use the remote storage in your local project, update your `nuxt.config.ts`:
3242

3343
```ts [nuxt.config.ts]
3444
export default defineNuxtConfig({
3545
hub: {
46+
// Always use remote storage in development
3647
remote: true
3748
}
3849
})
3950
```
4051

41-
When restarting your local server, the module will automatically use the remote data 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+
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**.
4253

4354
## Self-hosted
4455

@@ -62,15 +73,24 @@ Go back to the `Deployment` tab and retry the last deployment by clicing on `...
6273

6374
Once the deployment is done, NuxtHub should be ready to use in your deployed project.
6475

65-
### Remote data
76+
### Remote Storage
6677

67-
To enable remote data in your self-hosted project, the module requires a secret to access the remote data.
78+
To enable remote storage in your self-hosted project, the module requires a secret to access it.
6879

6980
1. Set the `NUXT_HUB_PROJECT_SECRET` environment variable in your Cloudflare Pages project settings and retry the last deployment to apply the changes.
70-
2. Set the same `NUXT_HUB_PROJECT_SECRET` and `NUXT_HUB_PROJECT_URL` environment variables in your local project:
81+
2. Set the same `NUXT_HUB_PROJECT_SECRET` and `NUXT_HUB_PROJECT_URL` environment variables in your local project
82+
7183
```bash [.env]
7284
NUXT_HUB_PROJECT_SECRET=my-project-secret-used-in-cloudflare-env
7385
NUXT_HUB_PROJECT_URL=https://my-nuxthub-project.pages.dev
7486
```
7587

7688
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+
Then, start your Nuxt project with:
91+
92+
```bash [Terminal]
93+
npx nuxt dev --remote
94+
```
95+
96+
Your development project will now use the remote storage from your deployed project.

0 commit comments

Comments
 (0)