https://github.com/jacobbubu/typescript-starter-gh

https://github.com/jacobbubu/typescript-starter-gh

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jacobbubu/typescript-starter-gh
• Owner: jacobbubu
• License: mit
• Created: 2020-04-05T11:49:29.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T02:47:29.000Z (about 2 years ago)
• Last Synced: 2024-11-13T16:12:02.188Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.66 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# --libraryname--

[![Build Status](https://github.com/--username--/--librarynamewithoutscope--/workflows/Build%20and%20Release/badge.svg)](https://github.com/--username--/--librarynamewithoutscope--/actions?query=workflow%3A%22Build+and+Release%22)

[![Coverage Status](https://coveralls.io/repos/github/--username--/--librarynamewithoutscope--/badge.svg)](https://coveralls.io/github/--username--/--librarynamewithoutscope--)

[![npm](https://img.shields.io/npm/v/--libraryname--.svg)](https://www.npmjs.com/package/--libraryname--/)

> A starter project that makes creating a TypeScript module extremely easy.

## Intro.

This tool was modified from [typescript-library-starter](https://github.com/alexjoverm/typescript-library-starter), but I made the following revisions:

  - Use GitHub Actions instead of TravisCI

  - Used to develop Node.JS Module instead of packaging code for browser

## Usage

```bash

git clone https://github.com/jacobbubu/typescript-starter.git YOURFOLDERNAME

cd YOURFOLDERNAME

npm install

```

**Start coding!** `package.json` and entry files are already set up for you, so don't worry about linking to your main file, typings, etc. Just keep those files with the same name.

## Before push

Before pushing the code to GitHub, please make sure that `NPM_TOKEN` is configured in `https://github.com/__your_repo__/settings/secrets`, or you can do this through [`semantic-release-cli`](https://github.com/semantic-release/cli).