Skip to content

A seed project for authoring javascript libraries in Typescript

License

Notifications You must be signed in to change notification settings

janux/typescript-seed

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Janux TypeScript Seed

Starting point to create projects based on typescript

Steps to start easily

Follow the instructions to start using the seed in the simplest way possible

  1. Get the seed/skeleton
git clone https://github.com/janux/typescript-seed.git
cd typescript-seed
  1. Install dependencies and typescript definitions
# Install by running:
npm install && tsd install
# Note: if you don't have TypeScript Definition manager (TSD), please install by running:
npm install tsd -g
  1. Look seed structure (Directory structure)
.
├── LICENSE
├── README.md
├── config
│	└── default.js
├── gulp
│   ├── clean.js
│   ├── doc.js
│   ├── scripts.js
│	└── test.js
├── src
│   ├── classExample.ts
│   └── collections.ts
├── test
│   ├── log4js.json
│   └── testExample.spec.js
├── dist
├── typings
│
├── .gitignore
├── gulpfile.js
├── index.js
├── package.json
└── tsd.json
  • src Typescript source files for your project
  • dist Used for the production build
  1. Compile typescript project
gulp default

Additional options

  • Generate documentation under doc
gulp doc
  • run tests under test
gulp test

typescript compiler configuration

The configuration options are under config

cfg.tsConfig = {
	sortOutput: true,
	module: "commonjs",
	removeComments: true,
	target:'ES5'
};

License

MIT

About

A seed project for authoring javascript libraries in Typescript

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •