Overview

This repo is a deprecated starter guide for integrating TypeScript and Vue. It was created before Vue shipped with TypeScript out of the box, and now the recommended way to get started is through the official CLI. Despite being deprecated, this repo is kept around as a useful archive.

Features

• Quick start guide for integrating TypeScript and Vue.
• Flexible steps that can be used to integrate TypeScript into an existing Vue project.
• Scaffold project with TypeScript files in src folder, compiled with TypeScript and webpack into a bundle.js file in dist folder.
• Components can be placed in src/components folder.

Installation

1. Create a new package.
2. Scaffold the project with the following structure:
   • TypeScript files in src folder.
   • Run the TypeScript compiler and webpack to generate bundle.js file in dist folder.
   • Components in src/components folder.
3. Initialize the project as an npm package.
4. Install the necessary dependencies, including TypeScript, webpack, Vue, and loaders.
5. If needed, install appropriate @types/ package for declaration files.
6. Create a tsconfig.json file in the project root with necessary compilation settings.
7. Add a webpack.config.js file for bundling the app.
8. Update the package.json file with a build script to run webpack.

Summary

This deprecated repo provides a quick start guide for integrating TypeScript and Vue. It outlines the installation process, project structure, and necessary configuration files. However, it is recommended to use the official CLI for starting a new TypeScript and Vue project instead.