Skip to content

Commit

Permalink
Merge pull request #259 from Genez-io/dev
Browse files Browse the repository at this point in the history
Release fixex, nuxt, nitro
  • Loading branch information
andreia-oca authored Sep 16, 2024
2 parents 49f46b2 + 89b5208 commit 0b71615
Show file tree
Hide file tree
Showing 5 changed files with 104 additions and 11 deletions.
4 changes: 4 additions & 0 deletions docs/cli-tool/cli-commands/genezio-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ description: Discover how to create fullstack or backend projects with the genez

`genezio create nitrojs [--name <project-name>] [--region <project-region>] [--path <project-path>] [--logLevel <log-level>] [-h | --help]`

#### Nuxt.js starter project

`genezio create nuxt [--name <project-name>] [--region <project-region>] [--path <project-path>] [--logLevel <log-level>] [-h | --help]`

#### Serverless function

`genezio create serverless [--name <project-name>] [--region <project-region>] [--path <project-path>] [--logLevel <log-level>] [-h | --help]`
Expand Down
4 changes: 2 additions & 2 deletions docs/features/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,8 @@ services:
email: true
web3: true
google:
id: ${{env.GOOGLE_CLIENT_ID}}
secret: ${{env.GOOGLE_SECRET}}
clientId: ${{env.GOOGLE_CLIENT_ID}}
clientSecret: ${{env.GOOGLE_SECRET}}
```
You can enable multiple authentication providers at the same time. The `providers` field is optional and you can enable only the providers you want.
Expand Down
87 changes: 87 additions & 0 deletions docs/frameworks/nuxt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
description: Learn how to deploy a Nuxt application with Genezio.
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import useBaseUrl from '@docusaurus/useBaseUrl';

# Nuxt

<head>
<title>Nuxt | Genezio Documentation</title>
</head>

Nuxt is a powerful framework for building Vue.js applications. It provides a lot of features out of the box, such as server-side rendering, static site generation, and more. Nuxt is a great choice for developers who want to build modern web applications with Vue.js.

:::tip
Get started in no time with the [Nuxt template](https://app.genez.io/start/deploy?repository=https://github.com/Genez-io/nuxt-getting-started).
:::

# Deployment

Learn how to deploy an existing Nuxt app using Genezio, a serverless deployment platform that simplifies app management and reduces costs.

### 1. Install genezio

Use your preferred package manager to install Genezio:

<Tabs>
<TabItem className="tab-item" value="npm" label="npm">
<div id="step1-install-npm">
```
npm install genezio -g
```
</div>
</TabItem>
<TabItem className="tab-item" value="pnpm" label="pnpm">
<div id="step1-install-pnpm">
```
pnpm add -g genezio
```
</div>
</TabItem>
<TabItem className="tab-item" value="yarn" label="yarn">
<div id="step1-install-yarn">
```
yarn add global genezio
```
</div>
</TabItem>
</Tabs>

### 2. Deploy your project

:::info
If you don't already have a Nuxt app, you can create one by running in your terminal:
```
genezio create nuxt --name nuxt-project --region us-east-1
```
:::

```bash
genezio deploy
```

This command will build your Nuxt application and deploy it to the cloud. Genezio uses a `genezio.yaml` file to store configuration about your project such as project name and region. When running the `genezio deploy` command, Genezio will create this file for you if it doesn't exist after asking you some interactive questions.

The `genezio.yaml` configuration file will look something like this:

```yaml
# The name of your project, which also influences the subdomain of the project.
name: genezio-project
# Select a region closest to your user base for optimal performance.
region: us-east-1
# Specifies the version of the YAML configuration syntax being used.
yamlVersion: 2
```
### 3. Monitor your project
You can monitor and manage your application through the [Genezio App Dashboard](https://app.genez.io/dashboard). The dashboard URL, also provided after deployment, allows you to access comprehensive views of your project's status and logs.
## Support <a href="#support" id="support"></a>
We invite you to join our community on [Discord](https://discord.gg/uc9H5YKjXv) for further information and help.
**Happy Learning!**
18 changes: 9 additions & 9 deletions docs/project-structure/genezio-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The name of the database. It is used to identify the database.

#### `region`: `string` **Optional**

The region where the database will be deployed. If not specified, the default region is `us-east-1`.
The region where the database will be deployed. If not specified, the default region the same as the project's region.

You should choose the region that is closest to your server to reduce latency.

Expand Down Expand Up @@ -119,8 +119,8 @@ services:
email: true
web3: true
google:
id: ${{env.GOOGLE_CLIENT_ID}}
secret: ${{env.GOOGLE_SECRET}}
clientId: ${{env.GOOGLE_CLIENT_ID}}
clientSecret: ${{env.GOOGLE_SECRET}}
settings:
resetPassword:
redirectUrl: https://${{frontend.<frontend-name>.subdomain}}.app.genez.io/reset-password
Expand Down Expand Up @@ -177,8 +177,8 @@ This field can be omitted if you don't want to enable any authentication provide
email: true
web3: true
google:
id: ${{env.GOOGLE_CLIENT_ID}}
secret: ${{env.GOOGLE_SECRET}}
clientId: ${{env.GOOGLE_CLIENT_ID}}
clientSecret: ${{env.GOOGLE_SECRET}}
```

#### `settings`: `Object` **Optional**
Expand Down Expand Up @@ -661,8 +661,8 @@ services:
email: true
web3: true
google:
id: ${{env.GOOGLE_CLIENT_ID}}
secret: ${{env.GOOGLE_SECRET}}
clientId: ${{env.GOOGLE_CLIENT_ID}}
clientSecret: ${{env.GOOGLE_SECRET}}
```

### Configure the reset password and email verification redirect URLs
Expand All @@ -684,8 +684,8 @@ services:
email: true
web3: true
google:
id: ${{env.GOOGLE_CLIENT_ID}}
secret: ${{env.GOOGLE_SECRET}}
clientId: ${{env.GOOGLE_CLIENT_ID}}
clientSecret: ${{env.GOOGLE_SECRET}}
settings:
resetPassword:
redirectUrl: https://${{frontend.<frontend-name>.subdomain}}.app.genez.io/reset-password
Expand Down
2 changes: 2 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ const sidebars = {
"frameworks/expressjs",
"frameworks/fastify",
"frameworks/nextjs",
"frameworks/nitro",
"frameworks/nuxt",
"frameworks/react",
"frameworks/react-admin",
"frameworks/refine",
Expand Down

0 comments on commit 0b71615

Please sign in to comment.