📄 template-web-ts-npm

Project Template for creating Web Apps with Typescript and npm Packages

🛠️ Development

These instructions will get you a copy of this project up and running on your local machine for development and testing purposes.

📋 Prerequisites

Software

• Node.js - A JavaScript run-time environment

Global npm packages

• gulp.js - The streaming build system for Node.js

npm install --global gulp-cli

VS Code Extensions

This project is intended to be used with Visual Studio Code and the following extensions are recommended:

• TSLint - TSLint for Visual Studio Code
• ESLint - Integrates ESLint into VS Code

🚀 Getting Started

This project uses npm scripts for running tasks:

# install all dependencies
npm install

## lint the project
# all TypeScript code
gulp lint:ts
# all JavaScript code
gulp lint:es
# both all TypeScript and JavaScript code
gulp lint

## build the project
# only once
gulp build
# on each change
gulp watch

## open output in browser
# only once
gulp serve
# on each change
gulp default

VS Code tasks are also included for gulp compile and gulp default.

🧰 Built With

• TypeScript - A typed superset of JavaScript that compiles to plain JavaScript
• TSLint - An extensible linter for the TypeScript language
• ESLint - The pluggable linting utility for JavaScript and JSX
• gulp.js - The streaming build system for Node.js
• browserify - Lets you require('modules') in the browser by bundling up all of your dependencies
• watchify - Watch mode for browserify builds

👨‍💻 Authors

• Robin Hartmann - robin-hartmann

📃 License

This project is licensed under the MIT License - see the LICENSE file for details.