Skip to content

A starter for a base Nuxt3 site, without UI bells and whistles. Most of Hex's other starters are derived from this one. Jamie Warburton is the tech lead for this.

Notifications You must be signed in to change notification settings

hex-digital/starter-nuxt3-new

Repository files navigation

Nuxt 3 Base - Hex Starter

A starter for a base Nuxt3 site, without UI bells and whistles.

Most other starters are derived from this one

  • A solid application architecture, ready to section application code by modules.
  • Barebones base components, with little-to-no UI theming. Customise as you like, knowing the basics are covered.
  • Set up for TypeScript.
  • Pre-integrated with Pinia.
  • Pre-integrated with Tailwind and PostCSS plugins configured.
  • Documentation to detail how it all works, and why.

Prerequisites / Setup

For installation and setup instructions, please read the Getting Started documentation.

Documentation

Please see the ~/docs directory for documentation.

Contributing

All contributions are welcome. Please see our Contribution Guidelines.

Lint and Test staged files pre-commit

When attempting to commit, the staged files will be linted, and any relevant tests will be run.

If the linting fails or the tests do not pass, you will be unable to commit.

In rare circumstances, this may block you from committing when we do not wish it to. In those cases, delete the offending line from the lint-staged key, in package.json. Note that this should be a temporary measure, and quickly remedied. Do not commit the package.json changes.

Conventional Commits

Our commit messages use conventional commits. If your commit message does not match the defined standard, you'll receive an error message and the commit will not be added.

To learn how to write conventional commits, please read the conventional commits guide.

Attribution

Thank you to numerous open source projects from which we've pulled ideas, inspiration and implementation for features and code.

  • Vitesse Nuxt3 for the initial Nuxt3 and Vite boilerplate. Thanks Anthony!
  • Vue Storefront for some excellent Nuxt composables, app structure and blog tutorials where we learnt alot.

And so much gratitude to the whole open source community for the many years of open source software we've built upon. Standing on the shoulders of absolute giants. 💪

About

A starter for a base Nuxt3 site, without UI bells and whistles. Most of Hex's other starters are derived from this one. Jamie Warburton is the tech lead for this.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published