-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Sébastien Chopin <[email protected]>
- Loading branch information
3 people
authored
Aug 15, 2024
1 parent
d09df1e
commit 5ba86f9
Showing
97 changed files
with
1,801 additions
and
694 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,102 @@ | ||
| --- | ||
| title: Introduction | ||
| description: NuxtHub helps you build full-stack applications on the Edge. | ||
| navigation.title: Introduction | ||
| title: What is NuxtHub? | ||
| description: NuxtHub helps you build and deploy full-stack Nuxt applications globally. | ||
| --- | ||
|
|
||
| NuxtHub aims to provide a complete backend experience for [Nuxt](https://nuxt.com) apps, allowing developers to build full-stack applications on the Edge, read more about [Nuxt on the edge](https://nuxt.com/blog/nuxt-on-the-edge). | ||
| On top of deploying your Nuxt application, NuxtHub aims to provide a complete backend experience on top of the framework, allowing developers to build full-stack applications on the Edge, read more about [Nuxt on the Edge](https://nuxt.com/blog/nuxt-on-the-edge). | ||
|
|
||
| ::callout | ||
| It is **currently made to be deployed on [Cloudflare Pages](https://pages.cloudflare.com)** as it leverages many Cloudflare features such as KV, D1, and R2. We are looking to support other platforms in the future. | ||
| It leverages Cloudflare features such as Pages, Workers Analytics, AI, KV, D1, R2 and more. | ||
|
|
||
| ::tip | ||
| **NuxtHub is what Vercel / Netlify is for AWS, but for Cloudflare.** :br | ||
| It also deploys to your Cloudflare account so you stay in control of your data and billing as we don't mark-up Cloudflare prices. | ||
| :: | ||
|
|
||
| ## Features | ||
|
|
||
| NuxtHub provides multiple features to help you build full-stack applications: | ||
| - **SQL database** to store your application's data with [`hubDatabase()`](/docs/storage/database) | ||
| - **Key-Value** to store JSON data accessible globally with low-latency with [`hubKV()`](/docs/storage/kv) | ||
| - **Blob storage** to store static assets, such as images, videos and more with [`hubBlob()`](/docs/storage/blob) | ||
| - **Cache storage** to cache your server route responses or functions using Nitro's [`cachedEventHandler`](https://nitro.unjs.io/guide/cache#cached-event-handlers) and [`cachedFunction`](https://nitro.unjs.io/guide/cache#cached-functions) | ||
|
|
||
| Each storage utils is auto-imported and configured to be used in your [Nuxt's server directory](https://nuxt.com/docs/guide/directory-structure/server). | ||
| NuxtHub provides optional features to help you build full-stack applications: | ||
| - [AI Models](/docs/features/ai) to run machine learning models, such as LLMs in Nuxt. | ||
| - [Blob storage](/docs/features/blob) to store static assets, such as images, videos and more | ||
| - [Caching system](/docs/features/cache) for your Nuxt pages, API routes or server functions | ||
| - [SQL database](/docs/features/database) to store your application's data | ||
| - [Key-Value](/docs/features/kv) to store JSON data accessible globally with low-latency | ||
| - [Open API](/docs/features/open-api) to generate your API documentation with [Scalar](https://scalar.com) | ||
|
|
||
| ::callout{icon="i-ph-plugs-connected-duotone" to="/docs/getting-started/deploy#remote-storage"} | ||
| ::tip{icon="i-ph-plugs-connected-duotone" to="/docs/getting-started/remote-storage"} | ||
| 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 with `npx nuxi dev --remote`. | ||
| :: | ||
|
|
||
| ## Packages | ||
|
|
||
| We plan to provide a complete backend experience for Nuxt apps through various `@nuxthub` packages. | ||
|
|
||
| - [`@nuxthub/core`](https://github.com/nuxt-hub/core): Main package to provide storage features | ||
| - `@nuxthub/auth`: Add authentication for user management (soon) | ||
| - `@nuxthub/email`: Send transactional emails to your users (soon) | ||
| - `@nuxthub/analytics`: Understand your traffic and track events within your application and API (soon) | ||
| - `@nuxthub/...`: You name it! | ||
|
|
||
| ::important | ||
| We are currently in the early stages of development (beta) and are looking for feedback from the community. If you are interested in contributing, please join us on [nuxt-hub/core](https://github.com/nuxt-hub/core). | ||
| :: | ||
|
|
||
| ## Admin | ||
| ## NuxtHub Admin | ||
|
|
||
| ::tabs | ||
| ::div{label="Projects"} | ||
| [{class="border rounded dark:border-gray-700 border-gray-200"}](https://admin.hub.nuxt.com) | ||
| {class="border rounded dark:border-gray-700 border-gray-200" data-zoom-src="/images/landing/nuxthub-admin.png"} | ||
| :: | ||
| ::div{label="Deployments"} | ||
| [{class="border rounded dark:border-gray-700 border-gray-200"}](https://admin.hub.nuxt.com) | ||
| {class="border rounded dark:border-gray-700 border-gray-200" data-zoom-src="/images/landing/nuxthub-admin-project.png"} | ||
| :: | ||
| ::div{label="Database"} | ||
| [{class="border rounded dark:border-gray-700 border-gray-200"}](https://admin.hub.nuxt.com) | ||
| {class="border rounded dark:border-gray-700 border-gray-200" data-zoom-src="/images/landing/nuxthub-admin-database.png"} | ||
| :: | ||
| ::div{label="KV"} | ||
| {class="border rounded dark:border-gray-700 border-gray-200" data-zoom-src="/images/landing/nuxthub-admin-kv.png"} | ||
| :: | ||
| ::div{label="Blob"} | ||
| {class="border rounded dark:border-gray-700 border-gray-200" data-zoom-src="/images/landing/nuxthub-admin-blob.png"} | ||
| :: | ||
| ::div{label="Logs"} | ||
| {class="border rounded dark:border-gray-700 border-gray-200" data-zoom-src="/images/landing/nuxthub-admin-server-logs.png"} | ||
| :: | ||
| ::div{label="Open API"} | ||
| {class="border rounded dark:border-gray-700 border-gray-200" data-zoom-src="/images/landing/nuxthub-admin-open-api.png"} | ||
| :: | ||
| ::div{label="Cache"} | ||
| {class="border rounded dark:border-gray-700 border-gray-200" data-zoom-src="/images/landing/nuxthub-admin-cache.png"} | ||
| :: | ||
| :: | ||
|
|
||
| The [NuxtHub admin](https://admin.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. | ||
|
|
||
| ### Features | ||
| The [NuxtHub admin](https://admin.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: | ||
| - Link your Cloudflare account and stay in control, we never mark-up Cloudflare prices | ||
| - Deploy your application with `nuxthub deploy` command | ||
| - Relax while it provisions all the necessary resources (database, kv, blob) | ||
| - [Deploy your application](/docs/getting-started/deploy) with `nuxthub deploy` command or with Cloudflare Pages CI | ||
| - Relax while it provisions all the necessary resources (ai, blob, cache, database, kv) | ||
| - Manage your app's resources with an admin panel | ||
| - Visualize application, database, and cache metrics | ||
| - Give access to team members to manage the application without sharing your Cloudflare account | ||
| - Monitor your application with logs and analytics | ||
|
|
||
| ::tip{icon="i-ph-rocket-launch-duotone" to="https://admin.hub.nuxt.com"} | ||
| Get started with NuxtHub Admin. | ||
| :: | ||
|
|
||
| ## Nuxt DevTools | ||
|
|
||
| NuxtHub also integrates with the [Nuxt DevTools](https://devtools.nuxt.com/) to provide a complete development experience. | ||
|
|
||
| ::tabs | ||
| ::div{label="Database"} | ||
| {class="border rounded dark:border-gray-700 border-gray-200" data-zoom-src="/images/landing/nuxt-devtools-database.png"} | ||
| :: | ||
| ::div{label="KV"} | ||
| {class="border rounded dark:border-gray-700 border-gray-200" data-zoom-src="/images/landing/nuxt-devtools-kv.png"} | ||
| :: | ||
| ::div{label="Blob"} | ||
| {class="border rounded dark:border-gray-700 border-gray-200" data-zoom-src="/images/landing/nuxt-devtools-blob.png"} | ||
| :: | ||
| :: | ||
|
|
||
| ## Upcoming Packages | ||
|
|
||
| We plan to provide a complete backend experience for Nuxt apps through various `@nuxthub` packages. | ||
|
|
||
| - [`@nuxthub/core`](https://github.com/nuxt-hub/core): Main package to provide storage features | ||
| - `@nuxthub/auth`: Add authentication for user management (soon) | ||
| - `@nuxthub/email`: Send transactional emails to your users (soon) | ||
| - `@nuxthub/analytics`: Understand your traffic and track events within your application and API (soon) | ||
| - `@nuxthub/...`: You name it! | ||
|
|
||
| ::important | ||
| We are currently in the early stages of development (beta) and are looking for feedback from the community. If you are interested in contributing, please join us on [nuxt-hub/core](https://github.com/nuxt-hub/core). | ||
| :: |
Oops, something went wrong.