Installation
Learn how to install and configure the NOBEARS Nuxt Module Starter template.
The NOBEARS Nuxt Module Starter template is a template that is used to create a new Nuxt module. It is a good starting point for creating a new Nuxt module that follows our coding standards, release process and more.
Setup
Clone the template in your desired location
bash
git clone https://git.nobears.nl/nobears-front-end/templates/nuxt-module-starter.git
Remove cloned git repository
bash
rm -rf .git
Add project to desired git repository
bash
git init --initial-branch=main
git remote add origin <your-git-repository>
Replace placeholders with actual values
Go over each file and verify that the placeholders have been replaced with actual values, before creating a commit.
With search and replace, you can easily replace the placeholders with actual values.
Also be sure to replace the placeholders listed below in their respective order, otherwise you will overwrite parts of other placeholders.
| Placeholder | Example Replacement |
|---|---|
placeholder_package_name | nuxt-statamic |
placeholderModuleConfigKey | nuxtStatamic |
PlaceholderPackageNameFormattedForTypesSimple | Statamic |
PlaceholderPackageNameFormattedForTypes | NuxtStatamic |
PlaceholderPackageNameFormatted | Nuxt Statamic |
Add your first commit
Before creating a commit, make sure you are on the correct branch. (see guidelines)
bash
git add .
git commit -m "chore(template): added NOBEARS Nuxt Module Starter template"
git push --set-upstream origin main