Skip to content

A NativeScript-Vue + Typescript starter kit for getting up and running quickly

Notifications You must be signed in to change notification settings

khawarizmus/NativeScript-Vue-Typescript-Starter-Kit

Repository files navigation

NativeScript-Vue Typescript Starter Kit

Logo

A NativeScript-Vue + Typescript starter kit for getting up and running quickly

Commitizen friendly semantic-release Build Status

sample

What do you get

This starter kit aims to make your development environment as efficient as possible, by having typescript integrated into our project we benefit from the language powerful features like, type checking, great tooling with IntelliSense support and a pure OOP paradigm.

This kit is commitizen friendly and uses commitlint, it comes with automated sementic-relese out of the box with Github changlog automated generation.

This kit uses ts-loader which is a typescript loader for webpack , fork-ts-checker-webpack-plugin for a better performance and offers you with vue-property-decorator to get the most out of typescript in your vue files.

Usage

We assume that you have all the prerequisites installed

Then You first need to clone the repo to your local machine

git init
git clone https://github.com/gimyboya/NativeScript-Vue-Typescript-Starter-Kit.git

Once done you need to point the remote origin to your own git repository

git remote set-url origin https://github.com/USERNAME/REPOSITORY.git

Then install the your packages

# Install dependencies
npm install

Scripts

The following scripts are available for you to run and build your application

Note: <platform> can be either android or ios

# to commit your changes using commitizen (important)
npm run commit

# run you app
npm run run:<platform>

# clean run your app
npm run clean-run:<platform>

# run with hot module reloading
npm run watch:<platform>

# build your app
npm run build:<platform>
    

Contribution

NOTE: This repo is commitizen friendly that follows AngularJS's commit message convention also known as conventional-changelog.

Contributions are welcomed.