Giter VIP home page Giter VIP logo

typescript-browserify-template's Introduction

typescript-browserify-template

My take on a minimal template for typescript projects.

How to use

npm run dist     # build & browserify (for using in vanilla js)
npm run build    # build only (for developemnt)
npm run bundle   # browserify only

How to reproduce this template from scratch

  1. npm init (you will probably want to do git init and add .gitignore as well)
  2. npm install --save-dev typescript browserify
  3. ./node_modules/.bin/tsc --init
  4. Edit the newly created tsconfig.json file, uncomment the "declaration" and "outDir" line, set "outDir" to be "./lib".
  5. Edit package.json to contain the following "script"s:
  "scripts": {
    "dist": "npm run build && npm run bundle",
    "build": "./node_modules/.bin/tsc",
    "bundle": "./node_modules/.bin/browserify  ./lib/index.js --s [moduleName] -o ./dist/bundle.js",
  },

where [modunleName] should be replaced with the name you want the bundled result (./dist/bundle.js) to use when creating the module instance. Also, feel free to change the ./dist/bundle.js part if you would like to use other file names.

  1. Set "main" in package.json to be ./lib/index.js.
  2. npm run build your package, and add the "typing" field in package.json.

What if I don't want to use index.ts as the entry point?

Just switch out occurences of index with [your name here] in package.json and it should work.

typescript-browserify-template's People

Contributors

bctnry avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.