Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/enriquebv/vue3-demo


https://github.com/enriquebv/vue3-demo

Last synced: 19 days ago
JSON representation

Awesome Lists containing this project

README

        

# vue3-hexagonal

This template should help get you started developing with Vue 3 in Vite.

## Architecture

To familiarize yourself with the codebase, read [ARCHITECTURE.md](./ARCHITECTURE.md).

## Getting started

### Pre-requisites

- [nvm](https://github.com/nvm-sh/nvm) installed
- Install node version present in `.nvmrc`.

#### Recommended IDE Setup

- [VSCode](https://code.visualstudio.com/).
- Install extensions recommended in `.vscode/extensions.json`.

### Project Setup

1. Copy `.env.template` to `.env` and fill with correct values (ask your manager):

```
cp .env.template .env
```

2. Change to required node version:

```
nvm use
```

3. Install dependencies

```sh
npm install
```

#### Compile and Hot-Reload for Development

```sh
npm run dev
```

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

```sh
npm run build
```

#### Run Unit Tests with [Vitest](https://vitest.dev/)

```sh
npm run test:unit
```

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

```sh
npm run lint
```