This is an ever-evolving, very opinionated architecture and dev environment for new Nuxt projects using Nuxt 2. This is inspired from (and most of the content taken from) the amazing Chris Fritz's Vue Enterprise Boilerplate Project. Thanks Chris :)
This is for now just a work in progress and is nowhere near finished but the idea is that you can clone/download it and play around it with. I will try to constantly add to it so that it has more and more features that one might come across when building a Nuxt project. Have fun and feel free to reach out or submit a pull request if you see anything that needs to be added or fixed.
- 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. - coming soon
- Speedy development: configurable generatorsso your productivity will skyrocket.
# 1. Clone the repository.
git clone https://github.com/debs-obrien/nuxt-boilerplate-project.git my-new-project
# 2. Enter your newly-cloned folder.
cd my-new-project
# 3. Install dependencies. Make sure yarn is installed: https://yarnpkg.com/lang/en/docs/install
yarn
# 4. Read the documentation linked below for "Setup and development".This project includes a docs folder with more details on:
- Architecture
- Components
- Setup and development
- Docs
- i18n
- images
- layouts
- nuxt config
- package.json
- pages
- performance
- plugins
- pwa
- Languages and technologies
- Tests and mocking the API
- Linting and formatting
- Editor integration
- Building and deploying to production
- Troubleshooting
Why would I use this boilerplate instead of generating a new project with Nuxt directly?
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.
This boilerplate aims to educate and empower users to configure these defaults to ideally suit their specific app and team. Call it your playground for playing around in and testing things out then choose what you want and add it to your own project.