https://github.com/rinminase/vue-ts-slim-template

🍹☘ A VueJS project in Typescript reduced to its bare minimum with proper formatting
https://github.com/rinminase/vue-ts-slim-template

babel husky prettier scss typescript vue vue-cli

Last synced: about 13 hours ago
JSON representation

🍹☘ A VueJS project in Typescript reduced to its bare minimum with proper formatting

• Host: GitHub
• URL: https://github.com/rinminase/vue-ts-slim-template
• Owner: RinMinase
• Created: 2020-06-16T07:26:15.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-13T02:13:56.000Z (almost 2 years ago)
• Last Synced: 2023-02-26T08:46:34.543Z (over 1 year ago)
• Topics: babel, husky, prettier, scss, typescript, vue, vue-cli
• Language: TypeScript
• Homepage:
• Size: 4.35 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
 VueJS Typescript Test Project 


## Introduction

A test VueJS project in Typescript reduced to its bare minimum while still retaining code layouting automations (prettier and linter).

## Getting Started

### Running the project

1. [Download](https://nodejs.org/en/) the latest Node version. This is marked as ` Current`. Install it on your machine.

2. This project uses Yarn instead of NPM. [Download](https://yarnpkg.com/latest.msi) Yarn. This is a faster package manager than the default `npm` one, likewise also manages your dependencies and handles its updates way better.

3. Clone the project and copy the ENV file

    ```

    git clone https://github.com/RinMinase/vue-ts-test-project.git vue-ts

    cd vue-ts

    cp .env.example .env

    ```

4. Install the dependencies then run the project

    ```

    yarn install

    yarn start

    ```

5. Fire up your browser and go to `localhost:3000`

### Building the project

Installations Required:

- [Node](https://nodejs.org/en/)

- [Yarn](https://yarnpkg.com/latest.msi)

1. Fire up your terminal inside the project folder.

2. Build the project by running:

    ```

    yarn build

    ```

3. This should generate a `dist/` folder inside the project folder.

### Project tasks

Task automation is based on [Yarn scripts](https://yarnpkg.com/lang/en/docs/cli/run/) or [NPM scripts](https://docs.npmjs.com/misc/scripts).

| Task                | Description                                                                                          |

| ------------------- | ---------------------------------------------------------------------------------------------------- |

| `yarn start`        | Run a **development server** on `http://localhost:3000/` while also watching for any file changes    |

| `yarn build`        | Compiles and minifies source code for production, outputs to `dist` folder                           |

| `yarn lint`         | Lints and fixes all TypeScript and Vue files to follow the project coding standards and layout       |

## Built with

*  [VueJS + Router + Vuex](https://vuejs.org//) - Web Framework

*  [TypeScript](https://www.typescriptlang.org/) - Language syntax

*  [Sassy CSS (SCSS)](https://sass-lang.com/) - CSS pre-processor

*  [Yarn](https://yarnpkg.com/) - Package Manager