Typescript Boilerplate Project

A starting point for canvas-based Typescript projects.

Getting Started

To get a local copy up and running follow these steps.

Installation

This template doesn't rely on any external dependencies or services.

1. Create a new repo using this one as the template (or click "Use this template" on github)

   gh repo create <MyRepoName> --template https://github.com/themikelester/ts-boilerplate.git

2. Modify per-project fields in webpack.common.js

   // @NOTE: These need to be updated per-project
   const WEB_TITLE = '<SomeTitle>'
   const WEB_DESC = '<SomeDescription>'
   const GITHUB_URL = 'https://github.com/<username>/<MyRepoName>';
   const GTAG_ID = <SomeGoogleAnalyticsID>;

3. Modify the name in package.json

   {
     "name": "MyRepoName",
     ...
   }

4. Modify Readme.md for your new repository

5. Install NPM dependency packages

   yarn install

(back to top)

Usage

1. Start the local web server

   yarn start

2. Visit http://localhost:8080 in your web browser

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)