/vue-enterprise-boilerplate

An ever-evolving, very opinionated architecture and dev environment for new Vue SPA projects using Vue CLI 3.

Primary LanguageJavaScript

Vue Enterprise Boilerplate

CircleCI

This is an ever-evolving, very opinionated architecture and dev environment for new Vue SPA projects using Vue CLI 3. Questions, feedback, and for now, even bikeshedding are welcome. 😄 If you'd like to increase the time I can spend on this project, as well as other Vue resources, please consider becoming a sponsor on Patreon. 🙏

⚠️ This project uses Vue CLI 3, which is currently in beta so may not yet be appropriate for production projects.

Features

  • Thorough documentation: Written with the same care as Vue's core docs to quickly train new team members and consolidate knowledge.
  • Guaranteed consistency: Opinionated linting for Vue, JavaScript/JSON, SCSS, and Markdown, integrated into Visual Studio Code and run against staged files on pre-commit.
  • First-class tests: Practice test-driven development with both unit and end-to-end tests. Unit tests with Jest live as first-class citizens alongside your source files, while Cypress provides reliable end-to-end tests in an intuitive GUI for development.
  • Speedy development: Between configurable generators, handy aliases, and global base components, your productivity will skyrocket.

Getting started

# 1. Clone the repository.
git clone https://github.com/chrisvfritz/vue-enterprise-boilerplate.git my-new-project

# 2. Enter your newly-cloned folder
cd my-new-project

# 3. Replace this README's CI badge with a note about when you started
# and a link to a compare URL, so that you can always get an overview
# of new features added to the boilerplate since you cloned.
node _start.js

# 4. Delete the start script, as there can be only one beginning.
rm _start.js

# 5. Read the documentation linked below for "Setup and development".

Documentation

This project includes a docs folder with more details on:

  1. Setup and development
  2. Architecture
  3. Languages and technologies
  4. Routing, layouts, and views
  5. State management
  6. Tests and mocking the API
  7. Linting and formatting
  8. Editor integration
  9. Building and deploying to production
  10. Troubleshooting

FAQ

Why would I use this boilerplate instead of generating a new project with Vue CLI directly?

Vue CLI aims for flexibility, making it as simple as possible for any team to set up a new project, no matter how big or small, whether it's an app or a library, or what languages and technologies are being used.

This boilerplate makes more assumptions. It assumes you're building a large app, possibly developed by a large team. It also makes a lot of default choices for you, based on what tends to work well for large, enterprise projects. At the same time, it aims to educate and empower users to configure these defaults to ideally suit their specific app and team.

Why would I use this boilerplate instead of Nuxt?

Nuxt is like a really smart personal assistant, immediately making you more productive by taking care of many concerns for you. This boilerplate is more of a personal coach, aiming to educate and empower users to essentially configure their own framework, ideally suited to their app and team.

If what you're building is very well-defined, with requirements and technical challenges that won't drastically change over time, I'd probably recommend Nuxt instead. For the needs of common applications, it's more than up to the task. If you're a startup trying to prove product-market fit and your primary goal is initial development speed, that's also a point in Nuxt's favor.

Here's when you might prefer building a project off the boilerplate instead:

  • The requirements for the product are very likely to change over time and you want to maintain maximum flexibility and control.
  • You'd like to focus on developing skills that will transfer across any Vue project.
  • You're working in a large team, so need tooling to help everyone avoid common mistakes, write in a consistent style, and avoid bikeshedding in PRs.

Finally, it's not an either-or situation. This boilerplate demonstrates many useful patterns for building robust applications that can also be applied to Nuxt apps. That means you could build a project with Nuxt, while still using this boilerplate as a study guide.

Can you build a Nuxt version of this boilerplate?

I might! I'll be focusing on this Vue CLI version for now, but once I've made most of the improvements on my roadmap and as time allows, I would like to start work on a Nuxt version. The Nuxt team has even generously offered to help!