Nimiq Nuxt Template

This template should help you get started developing with Nimiq in Nuxt. Highly opinionated!

Try it now!

This template requires Node >=18

GitHub Template

Create a repo from this template on GitHub. You can use the button "Use this template" in the top right.

Clone to local

If you prefer to do it manually with the cleaner git history

npx degit onmax/nimiq-nuxt-template my-awesome-nimiq-app
cd my-awesome-nimiq-app
pnpm i

Note

If you don't have pnpm installed, run: npm install -g pnpm. Alternatively, you can delete pnpm-lock.yaml and use npm or yarn

Now make sure to update the following files:

• package.json: Update the name, version, description, author, repository, bugs, and homepage fields.
• vite.config.ts: Update the base field to match your repository name or custom domain.

the whole is not SSR since Nimiq Web Client is suppose to run in the client. You can modify this behaviour as you want and create islands

Features

• Includes @nimiq/core@next and connects to the Nimiq Albatross Testnet.
• Uses nimiq-css and Nimiq Icons for the UI. Supports dark mode!
• Some nuxt modules already installed
• Added unocss with attributify mode.

Other templates

• Vue 3 Nimiq Template

Recommended IDE Setup

VSCode + Volar.

Project Setup

pnpm install

Compile and Hot-Reload for Development

pnpm dev

Type-Check, Compile and Minify for Production

pnpm build