https://github.com/mrsunshyne/vue3-enterprise-boilerplate

A boilerplate to get started with a Vue 3 project fast
https://github.com/mrsunshyne/vue3-enterprise-boilerplate

Last synced: 2 months ago
JSON representation

A boilerplate to get started with a Vue 3 project fast

• Host: GitHub
• URL: https://github.com/mrsunshyne/vue3-enterprise-boilerplate
• Owner: MrSunshyne
• License: mit
• Created: 2021-08-22T08:44:54.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T04:00:59.000Z (about 2 years ago)
• Last Synced: 2025-01-26T02:52:01.441Z (4 months ago)
• Language: Vue
• Size: 771 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Vue 3 Enterprise Boilerplate

A boilerplate to get you started with a Vue 3 project fast.

- ViteJS

- TailwindCSS

- Page Transitions

- Composition API

- TailwindUI

- VueX

- HeadlessUI

- Heroicons

- VueUse

## Usage

### Getting Started 🚀

[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/MrSunshyne/vue3-enterprise-boilerplate)

### Using degit

```sh

npx degit MrSunshyne/vue3-enterprise-boilerplate v3-app

cd v3-app

```

## Recommendations

### Project Structure

`@`

The @ symbol points to the `src` folder

`src/pages`

- These are what you would typically import in your `routes.js` file

- File names should follow this convention : `Page`. eg. `PageAbout, PageHome, PageProfile`

`src/components`

- All shared components live under this folder.

- Components are usually imported in `Pages` to constitute a full page

`src/components/commmon`

- Sometimes components can share sub components, these can live in the common folder.

- Files from common should not be imported directly into `Pages`