NJS's Vue Template

A nice and simple Vue template to let me (or anyone else) quickly whip up new projects.

Features

• Vue + TypeScript
• Vue Router (Router and routes are found in ./src/routes)
• Vite
• Yarn for package management
• ESLint and Prettier with some sensible defaults.
• Tailwind CSS + DaisyUI

VS Code Extensions

• Volar
• TypeScript Vue Plugin (Volar)
• JavaScript and TypeScript Nightly
• Tailwind CSS Intellisense
• ESLint
• Prettier
• markdownlint with some basic settings.
• Code Spell Checker
• Todo Tree
• Git History
• Git Graph

Coding style

This ESLint and Prettier config uses double-quotes and semicolons.

const msg = "wow";

Installation

You can download this repo as a .zip or clone it with git, but a cleaner approach is with degit.

npx degit njs-templates/njs-vue new-project
cd new-project
yarn

Recommended IDE

This was meant to be used with VS Code, but it should work with any editor. You'll be prompted to install any recommended extensions that aren't installed. If no one on your team is using VS Code, just delete the .vscode/ folder.

Next steps

• Run yarn dev to start Vite and make sure everything's working.
• In package.json, change the project name and version.
• Delete the following:
  • LICENSE.txt from the root of the directory.
    • If your project still uses an MIT License, just edit the author and year.
  • Either delete CHANGELOG.md or remove its contents.
  • The boilerplate from src/App.vue, src/components/HelloWorld.vue and src/style.css.
    • You can easily do this from the Todo Tree tab in VS Code.
  • The .git/ folder if you cloned this repo.
• Run a git init to start tracking changes.
• Do whatever. This code is yours now. Credit is appreciated but not needed.