# typestart

> Typescript DOM library starter template

Latest version **3.0.1** (published 2019-08-13) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install typestart
pnpm add typestart
yarn add typestart
bun add typestart
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2019-08-13 |
| First published | 2019-02-16 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 13.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Anand Chowdhary |
| Maintainers | anandchowdhary |

## Links

- npm: https://www.npmjs.com/package/typestart
- Repository: https://github.com/AnandChowdhary/typestart
- Homepage: https://github.com/AnandChowdhary/typestart#readme
- Issues: https://github.com/AnandChowdhary/typestart/issues
- npm.io page: https://npm.io/package/typestart

## Dependencies (1)

- [mitt](https://npm.io/package/mitt.md) ^1.1.3

## Recent versions

- 3.0.1 (latest) — 2019-08-13
- 3.0.0 — 2019-08-13
- 2.0.0 — 2019-02-20
- 1.0.0 — 2019-02-16
- 0.9.0 — 2019-02-16

## README

# 📦 Typestart

[![Travis CI](https://img.shields.io/travis/AnandChowdhary/typestart.svg)](https://travis-ci.org/AnandChowdhary/typestart)
[![Coverage Status](https://coveralls.io/repos/github/AnandChowdhary/typestart/badge.svg?branch=master)](https://coveralls.io/github/AnandChowdhary/typestart?branch=master)
[![GitHub](https://img.shields.io/github/license/anandchowdhary/typestart.svg)](https://github.com/AnandChowdhary/typestart/blob/master/LICENSE)
![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/AnandChowdhary/typestart.svg)
[![Minzipped size](https://img.shields.io/bundlephobia/minzip/typestart.svg)](https://www.npmjs.com/package/typestart)

Typestart is a web/DOM library starter with these features:

- [x] Written in Typescript
- [x] Built-in demo with GitHub pages (`./docs/` folder)
- [x] main/module/types in `package.json`
- [x] Bundled as UMD (works as a module)
- [x] Exposes `window.Library` (works with CDNs)
- [x] Style with Sass
- [x] Test with Jest
- [x] Build with Travis CI
- [x] Clean with Prettier

## ⭐ Getting started

Clone and start your project:

```bash
git clone git@github.com:AnandChowdhary/typestart
mv typestart my-library && cd my-library
sudo rm -r .git && git init
```

Find and replace "typestart" with your library name and "AnandChowdhary" with your GitHub username.

### GitHub configuration

Setup GitHub Pages demo by going to Settings → GitHub Pages → Source → master branch /docs folder.

### Development

Start development server with HMR and prettier:

```bash
yarn start
```

### Production

Build a production version:

```bash
yarn build
```

## 🛠️ Using a Typestart library

Install the library as a dependency:

```bash
npm install typestart
```

Or, if you're using Yarn:

```bash
yarn add typestart
```

Then import the library:

```js
import Typestart from "typestart";
```

And initialize it with an optional selector:

```js
const typestart = new Typestart("#heading");
```

You can also use a CDN:

```html
<script src="https://unpkg.com/typestart"></script>
```

## 💡 Why another starter?

I've used a bunch of different Typescript library starters, but they all have tons of boilerplate (super long build rules, scripts for releases, publishing, building, etc.) 

Typestart is—like the name suggests—a starting point.

## 📝 License

Unlicense (public domain, do whatever you want)

---
_Source: https://npm.io/package/typestart · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._