docs: Added Nuxt server side and static example

This commit is contained in:
StefanVDWeide 2024-11-12 12:54:11 +01:00
parent d707a2785e
commit b4669e83a1
10 changed files with 9663 additions and 0 deletions

24
nuxt/.gitignore vendored Normal file
View File

@ -0,0 +1,24 @@
# Nuxt dev/build outputs
.output
.data
.nuxt
.nitro
.cache
dist
# Node dependencies
node_modules
# Logs
logs
*.log
# Misc
.DS_Store
.fleet
.idea
# Local env files
.env
.env.*
!.env.example

60
nuxt/README.md Normal file
View File

@ -0,0 +1,60 @@
# Nuxt Example
This repository contains an example of a Nuxt application that is deployed on Dokploy. There are two ways to deploy this application:
- With server side rendering
- As a static site
All example assume you use `Nixpacks` as the build type.
## Server side rendering
1. **Use Git Provider in Your Application**:
- Repository: `https://github.com/Dokploy/examples.git`
- Branch: `main`
- Build path: `/nuxt`
2. **Add Environment Variables**:
- Navigate to the "Environments" tab and add the following variable:
```plaintext
NIXPACKS_START_CMD="node .output/server/index.mjs"
```
3. **Click on Deploy**:
- Deploy your application by clicking the deploy button.
4. **Generate a Domain**:
- Click on generate domain button.
- A new domain will be generated for you.
- You can use this domain to access your application.
## Static site
1. **Use Git Provider in Your Application**:
- Repository: `https://github.com/Dokploy/examples.git`
- Branch: `main`
- Build path: `/nuxt`
2. **Add Environment Variables**:
- Navigate to the "Environments" tab and add the following variable:
```plaintext
NIXPACKS_BUILD_CMD="npm run generate"
```
3. **Set the publish publish directory**:
- Ensure you set it to `dist/`. Note that there is no dot before `dist`!
4. **Click on Deploy**:
- Deploy your application by clicking the deploy button.
5. **Generate a Domain**:
- Click on generate domain button.
- A new domain will be generated for you.
- You can use this domain to access your application.
If you need further assistance, join our [Discord server](https://discord.com/invite/2tBnJ3jDJc).

6
nuxt/app.vue Normal file
View File

@ -0,0 +1,6 @@
<template>
<div>
<NuxtRouteAnnouncer />
<NuxtWelcome />
</div>
</template>

5
nuxt/nuxt.config.ts Normal file
View File

@ -0,0 +1,5 @@
// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
compatibilityDate: '2024-04-03',
devtools: { enabled: true }
})

9543
nuxt/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

17
nuxt/package.json Normal file
View File

@ -0,0 +1,17 @@
{
"name": "nuxt-app",
"private": true,
"type": "module",
"scripts": {
"build": "nuxt build",
"dev": "nuxt dev",
"generate": "nuxt generate",
"preview": "nuxt preview",
"postinstall": "nuxt prepare"
},
"dependencies": {
"nuxt": "^3.14.159",
"vue": "latest",
"vue-router": "latest"
}
}

BIN
nuxt/public/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

1
nuxt/public/robots.txt Normal file
View File

@ -0,0 +1 @@

View File

@ -0,0 +1,3 @@
{
"extends": "../.nuxt/tsconfig.server.json"
}

4
nuxt/tsconfig.json Normal file
View File

@ -0,0 +1,4 @@
{
// https://nuxt.com/docs/guide/concepts/typescript
"extends": "./.nuxt/tsconfig.json"
}