Overview:
The vue-monorepo-boilerplate is a full stack application monorepo boilerplate built with Vue. It uses Lerna and Yarn Workspaces to manage the monorepo structure. The boilerplate includes front-end, server, and common module packages. The front-end package utilizes Vue SPA using Vue-cli 3, while the server package is built with Node+Express. There is also a common package that contains code shared between the front-end and server. The documentation for the boilerplate is developed using Vuepress and hosted on GitHub pages. CI/CD is implemented using Travis CI and Docker build is supported.
Features:
- Lerna and Yarn Workspaces for monorepo management
- Full stack application with front-end, server, and common module packages
- Front-end package built with Vue SPA using Vue-cli 3
- Server package built with Node+Express
- Common package for shared code between front-end and server
- Documentation developed with Vuepress and hosted on GitHub pages
- CI/CD implemented using Travis CI
- Docker build supported
Installation:
- Install Lerna, Yarn, and vue-cli globally in your development environment.
npm install -g lerna yarn @vue/cli
- Run the following top-level scripts to set up the environment and install packages:
- To install all packages and set up links for internal packages using Lerna:
yarn run bootstrap
- To run the server and start the UI server with hot reload in parallel:
yarn run dev
- To execute tests in all packages:
yarn run test
- To execute tests in a specific package:
yarn run test:<package-name>
- To build Vuepress documentation:
yarn run docs:build
- To deploy Vuepress documentation to GitHub pages:
yarn run docs:deploy
- To build the Docker image:
yarn run docker:build
- To publish public packages using Lerna:
yarn run publish
Summary:
The vue-monorepo-boilerplate is a comprehensive monorepo boilerplate for building full stack applications with Vue. It provides a convenient and efficient way to manage packages, build front-end and server components, share common code, and deploy your application. The boilerplate includes extensive documentation, CI/CD integration, and Docker support, allowing developers to focus on building their application rather than setting up the development environment.