124 lines
1.8 KiB
Markdown
124 lines
1.8 KiB
Markdown
|
|
||
|
|
|
||
|
|
# Nuxt UI Pro - SaaS template
|
||
|
|
|
||
|
|
[](https://ui.nuxt.com/pro)
|
||
|
|
|
||
|
|
- [Live demo](https://saas-template.nuxt.dev/)
|
||
|
|
- [Play on Stackblitz](https://stackblitz.com/github/nuxt-ui-pro/saas)
|
||
|
|
- [Documentation](https://ui.nuxt.com/pro/getting-started)
|
||
|
|
|
||
|
|
## Quick Start
|
||
|
|
|
||
|
|
```bash [Terminal]
|
||
|
|
npx nuxi init -t github:nuxt-ui-pro/saas
|
||
|
|
```
|
||
|
|
|
||
|
|
## Setup
|
||
|
|
|
||
|
|
Make sure to install the dependencies:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# npm
|
||
|
|
npm install
|
||
|
|
|
||
|
|
# pnpm
|
||
|
|
pnpm install
|
||
|
|
|
||
|
|
# yarn
|
||
|
|
yarn install
|
||
|
|
|
||
|
|
# bun
|
||
|
|
bun install
|
||
|
|
```
|
||
|
|
|
||
|
|
## Development Server
|
||
|
|
|
||
|
|
Start the development server on `http://localhost:3000`:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# npm
|
||
|
|
npm run dev
|
||
|
|
|
||
|
|
# pnpm
|
||
|
|
pnpm run dev
|
||
|
|
|
||
|
|
# yarn
|
||
|
|
yarn dev
|
||
|
|
|
||
|
|
# bun
|
||
|
|
bun run dev
|
||
|
|
```
|
||
|
|
|
||
|
|
## Production
|
||
|
|
|
||
|
|
Build the application for production:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# npm
|
||
|
|
npm run build
|
||
|
|
|
||
|
|
# pnpm
|
||
|
|
pnpm run build
|
||
|
|
|
||
|
|
# yarn
|
||
|
|
yarn build
|
||
|
|
|
||
|
|
# bun
|
||
|
|
bun run build
|
||
|
|
```
|
||
|
|
|
||
|
|
Locally preview production build:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# npm
|
||
|
|
npm run preview
|
||
|
|
|
||
|
|
# pnpm
|
||
|
|
pnpm run preview
|
||
|
|
|
||
|
|
# yarn
|
||
|
|
yarn preview
|
||
|
|
|
||
|
|
# bun
|
||
|
|
bun run preview
|
||
|
|
```
|
||
|
|
|
||
|
|
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
|
||
|
|
|
||
|
|
## Nuxt Studio integration
|
||
|
|
|
||
|
|
Add `@nuxthq/studio` dependency to your package.json:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# npm
|
||
|
|
npm install --save-dev @nuxthq/studio
|
||
|
|
|
||
|
|
# pnpm
|
||
|
|
pnpm add -D @nuxthq/studio
|
||
|
|
|
||
|
|
# yarn
|
||
|
|
yarn add -D @nuxthq/studio
|
||
|
|
|
||
|
|
# bun
|
||
|
|
bun add -d @nuxthq/studio
|
||
|
|
```
|
||
|
|
|
||
|
|
Add this module to your `nuxt.config.ts`:
|
||
|
|
|
||
|
|
```ts
|
||
|
|
export default defineNuxtConfig({
|
||
|
|
...
|
||
|
|
modules: [
|
||
|
|
...
|
||
|
|
'@nuxthq/studio'
|
||
|
|
]
|
||
|
|
})
|
||
|
|
```
|
||
|
|
|
||
|
|
Read more on [Nuxt Studio docs](https://nuxt.studio/docs/projects/setup).
|
||
|
|
|
||
|
|
## Renovate integration
|
||
|
|
|
||
|
|
Install [Renovate GitHub app](https://github.com/apps/renovate/installations/select_target) on your repository and you are good to go.
|