vue-guidelines

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #go #android #deep-learning #linux #docker #nodejs #awesome #cli #security #ios #openai

(★ 9)

Frontend project scaffolds, folder structures, best practices guidelines

vue-guidelines Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Softonix Vue Guidelines

Due to standardization purposes among our teams in Softonix, we would like to have a pretty strict standard project structure based on top of Vue.js.

Besides this, we also propose a list of frontend best practices which we must follow for consistency reasons.

### Prerequisition
- Familiarity with the command line
- Install Node.js version 20.19.0 or higher (22.12.0+ recommended)
- Create `.env` file in the project root and place `VITE_API_URL=https://jsonplaceholder.typicode.com` there.

## Recommended IDE Setup

[VS Code](https://code.visualstudio.com/) + [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).

## Recommended Browser Setup

- Chromium-based browsers (Chrome, Edge, Brave, etc.):
  - [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
  - [Turn on Custom Object Formatter in Chrome DevTools](http://bit.ly/object-formatters)
- Firefox:
  - [Vue.js devtools](https://addons.mozilla.org/en-US/firefox/addon/vue-js-devtools/)
  - [Turn on Custom Object Formatter in Firefox DevTools](https://fxdx.dev/firefox-devtools-custom-object-formatters/)

## Type Support for `.vue` Imports in TS

TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.

## Customize configuration

See [Vite Configuration Reference](https://vite.dev/config/).

## Project Setup

```sh
npm install
```

### Compile and Hot-Reload for Development

```sh
npm run dev
```

### Type-Check, Compile and Minify for Production

```sh
npm run build
```

### Lint with [ESLint](https://eslint.org/)

```sh
npm run lint
```

### Type-Check

```sh
npm run type-check
```

vue-guidelines

vue-guidelines Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

vue-guidelines

vue-guidelines Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README