https://github.com/onmax/nimiq-nuxt-template
This template should help you get started developing with Nimiq in Nuxt 3. Highly opinionated.
https://github.com/onmax/nimiq-nuxt-template
nimiq nuxt
Last synced: 5 months ago
JSON representation
This template should help you get started developing with Nimiq in Nuxt 3. Highly opinionated.
- Host: GitHub
- URL: https://github.com/onmax/nimiq-nuxt-template
- Owner: onmax
- Created: 2024-05-14T09:23:42.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T23:44:11.000Z (over 1 year ago)
- Last Synced: 2025-10-10T10:08:02.412Z (8 months ago)
- Topics: nimiq, nuxt
- Language: Vue
- Homepage: https://nuxt-template.nuxt.dev
- Size: 1010 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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
```bash
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](https://github.com/onmax/nimiq-vue-template)
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar).
## Project Setup
```sh
pnpm install
```
### Compile and Hot-Reload for Development
```sh
pnpm dev
```
### Type-Check, Compile and Minify for Production
```sh
pnpm build
```