https://github.com/johannschopplich/nuxt-prepare
🦎 Build actions for Nuxt
https://github.com/johannschopplich/nuxt-prepare
nuxt nuxt-assets nuxt-module
Last synced: 6 months ago
JSON representation
🦎 Build actions for Nuxt
- Host: GitHub
- URL: https://github.com/johannschopplich/nuxt-prepare
- Owner: johannschopplich
- License: mit
- Created: 2023-08-16T18:45:08.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T16:24:26.000Z (9 months ago)
- Last Synced: 2025-04-02T13:18:47.858Z (6 months ago)
- Topics: nuxt, nuxt-assets, nuxt-module
- Language: TypeScript
- Homepage: https://nuxt-prepare.byjohann.dev
- Size: 3.09 MB
- Stars: 103
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://nuxt-prepare.byjohann.dev)
# Nuxt Prepare
[Nuxt](https://nuxt.com) module to run async initialization steps at build-time.
- [✨ Release Notes](https://github.com/johannschopplich/nuxt-prepare/releases)
- [📖 Read the documentation](https://nuxt-prepare.byjohann.dev)
## Features
- 🦦 Zero-Config
- 🦎 Run sync or async operations when Nuxt builds your app
- ✂️ Conditionally overwrite runtime config or app config values
- 🍡 Run scripts in series or parallel
- 🥢 Ready for [Nitro](https://nitro.build) server routes
- 🦾 Better DX with [`defineNuxtPrepareHandler`](https://nuxt-prepare.byjohann.dev/api/define-nuxt-prepare-handler)
## Setup
> [!TIP]
> [📖 Read the documentation](https://nuxt-prepare.byjohann.dev)
```bash
npx nuxi@latest module add prepare
```
## Basic Usage
> [!TIP]
> [📖 Read the documentation](https://nuxt-prepare.byjohann.dev)
Add the `nuxt-prepare` module to your `nuxt.config.ts`:
```ts
// `nuxt.config.ts`
export default defineNuxtConfig({
modules: ['nuxt-prepare']
})
```
By default, Nuxt Prepare will look for a `server.prepare.ts` file in your project root. To run synchronous or asynchronous code when Nuxt builds your app, define a handler in your project root and export a default function:
```ts
// `server.prepare.ts`
import { defineNuxtPrepareHandler } from 'nuxt-prepare/config'
export default defineNuxtPrepareHandler(async () => {
// Do some async magic here, e.g. fetch data from an API
return {
// Overwrite the runtime config variable `foo`
runtimeConfig: {
public: {
foo: 'Overwritten by "server.prepare" script'
}
},
// Pass custom state to Nuxt and import it
// anywhere from `#nuxt-prepare`
state: {
foo: 'bar'
}
}
})
```
> [!TIP]
> You can run as many prepare scripts as you want – add them to the `prepare.scripts` module configuration.
## 💻 Development
1. Clone this repository
2. Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
3. Install dependencies using `pnpm install`
4. Run `pnpm run dev:prepare`
5. Start development server using `pnpm run dev`
## Credits
- [Maronbeere](https://maronbeere.carrd.co) for his Chameleon pixel art.
- [McPizza0](https://github.com/McPizza0) for his inspirational [`nuxt-server-init`](https://github.com/McPizza0/nuxt-server-init) module.
## License
[MIT](./LICENSE) License © 2023-PRESENT [Johann Schopplich](https://github.com/johannschopplich)