-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
102 additions
and
88 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,53 @@ | ||
--- | ||
title: Introduction | ||
description: Welcome to NuxtHub documentation. | ||
description: NuxtHub helps you build full-stack applications on the Edge. | ||
--- | ||
|
||
NuxtHub is a Nuxt Toolkit to create full-stack applications on the Edge. It is powered by Cloudflare Pages and leverages many Cloudflare features such as KV, D1, and R2, offering a complete backend experience. | ||
NuxtHub aims to provide a complete backend experience for [Nuxt](https://nuxt.com) apps, allowing developers to build full-stack applications 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. | ||
:: | ||
|
||
## Features | ||
|
||
- Session management | ||
- Query a SQLite database with [Database](/usage/database) | ||
- Access key-value storage with [KV](/usage/kv) | ||
- Store files with [Blob](/usage/blob) | ||
- Track events with [Analytics](/usage/analytics) | ||
NuxtHub provides a set of features to help you build full-stack applications: | ||
- **SQL database** to store your application's data | ||
- **Blob storage** to store static assets, such as images, video and more | ||
- **Key-Value** to store JSON data accessible globally with low-latency | ||
|
||
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). | ||
|
||
::callout{icon="i-ph-plugs-connected-duotone"} | ||
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. | ||
:: | ||
|
||
## Modules | ||
|
||
We plan to provide a complete backend experience for Nuxt apps through various `@nuxthub` modules. | ||
|
||
- [`@nuxthub/core`](https://github.com/nuxt-hub/core): Main module to provide storage features | ||
- `@nuxthub/auth`: Authentication module for user management | ||
- `@nuxthub/analytics`: Analytics module to track events within your applicaiton and API | ||
- `@nuxthub/...`: You name it! | ||
|
||
::callout | ||
We are currently in the early stages of development 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). | ||
:: | ||
|
||
## Console (alpha) | ||
|
||
The [NuxtHub console](https://hub.nuxt.com) lets you deploy your NuxtHub apps with single command on your Cloudflare account while provisioning all the necessary resources for you. | ||
|
||
### Features | ||
|
||
- Link your Cloudflare account and stay in control, we never mark-up Cloudflare prices. | ||
- Deploy your application with `nuxthub deploy` command | ||
- Relax while it provision all the necessary resources (database, kv, blob) | ||
- Manage your app's resources with your admin panel | ||
- Give access to team members to manage the application without sharing your Cloudflare account | ||
- Monitor your application with logs and analytics | ||
|
||
::callout | ||
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. | ||
:: |
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
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