https://github.com/oresoftware/typescript-library-skeleton

Clone this repo to provide yourself with a project skeleton for Node.js libraries written in TypeScript.
https://github.com/oresoftware/typescript-library-skeleton

javascript nodejs nodejs-framework nodejs-library npm-module npm-package scaffold skeleton typescript

Last synced: about 1 month ago
JSON representation

Clone this repo to provide yourself with a project skeleton for Node.js libraries written in TypeScript.

• Host: GitHub
• URL: https://github.com/oresoftware/typescript-library-skeleton
• Owner: ORESoftware
• License: other
• Created: 2018-04-09T15:37:01.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-12T02:54:51.000Z (over 1 year ago)
• Last Synced: 2025-05-11T03:33:21.311Z (about 1 month ago)
• Topics: javascript, nodejs, nodejs-framework, nodejs-library, npm-module, npm-package, scaffold, skeleton, typescript
• Language: Shell
• Homepage:
• Size: 83 KB
• Stars: 16
• Watchers: 2
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        



Travis build status:

[![Build Status](https://travis-ci.org/ORESoftware/typescript-library-skeleton.svg?branch=master)](https://travis-ci.org/ORESoftware/typescript-library-skeleton)

CircleCI build status:

[![CircleCI](https://circleci.com/gh/ORESoftware/typescript-library-skeleton/tree/master.svg?style=svg)](https://circleci.com/gh/ORESoftware/typescript-library-skeleton/tree/master)



:strawberry:

:raspberry:

:banana:

## TSLS - TypeScript Library Skeleton

  Hidden Details!

 LOL j/k

####  Your Project Readme Goes Here

This skeleton project is designed for TS/Node.js libraries, SDKs, and applications.




### To do things the simple way:

Steps to making this project skeleton your own project base.

1. Clone this repo: 


    `git clone https://github.com/ORESoftware/typescript-library-skeleton.git YOUR-PROJECT-NAME`

2. Update package.json so that `name` property matches ``.

3. 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.

Of course you can use Github or other hosting platforms instead of NPM to deliver your library.

### This project skeleton uses:

* the correct semver initial value (npm init defaults to 1.0.0 which is just wrong).

* typescript version 3.4.5

* nodejs version 12

* 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)

#### Power users

This project is used by: https://github.com/oresoftware/ts-project

You can use ts-project to do things even more automatically.