Travis build status: [](https://travis-ci.org/ORESoftware/typescript-library-skeleton)
CircleCI build status: [](https://circleci.com/gh/ORESoftware/typescript-library-skeleton/tree/master)
# Your Project Readme Goes Here
This project is used by: https://github.com/oresoftware/ts-project You can use ts-project to do things more automatically.
To do things more manually, continue on.
Steps to making this project skeleton your own project base.
- Clone this repo:
git clone https://github.com/ORESoftware/typescript-library-skeleton.git YOUR-PROJECT-NAME - Update package.json so that
nameproperty matchesYOUR-PROJECT-NAME. - Update other package.json fields so that they are accurate.
To check to see if YOUR-PROJECT-NAME is available on NPM, uses this command at the command line:
$ npm view YOUR-PROJECT-NAME # will give you a 404 if the name is available.
- the correct semver initial value (npm init defaults to 1.0.0 which is just wrong).
- typescript 2.9.x
- nodejs version 10
- travis/circleci (for automated testing of your library)
- MIT license
- good simple default settings for .gitignore / .npmignore / .editorconfig / .gitattributes
- Transpiling from src to dist folders (by default; you can change it manually)
To transpile files in place, instead of tranpiling from 'src' to 'dist':
update tsconfig.json (remove the `outDir` line):
"compilerOptions": {
"outDir": "dist"
}For small projects with just one .ts/.js file, you can just get rid of the src/lib folder, and put your index.ts
file in the root of the project. In that case, make sure to change the main property in package.json from 'lib/index.js' to
'index.js'. Same with the typings/types properties.