https://github.com/whatsaaaa/ts-library-template

Example TypeScript Library
https://github.com/whatsaaaa/ts-library-template

api-documenter api-extractor babel eslint javascript jest library typescript volta

Last synced: 15 days ago
JSON representation

Example TypeScript Library

• Host: GitHub
• URL: https://github.com/whatsaaaa/ts-library-template
• Owner: whatsaaaa
• Created: 2021-01-14T20:38:51.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-01-14T21:58:57.000Z (about 4 years ago)
• Last Synced: 2024-11-15T15:24:21.521Z (3 months ago)
• Topics: api-documenter, api-extractor, babel, eslint, javascript, jest, library, typescript, volta
• Language: TypeScript
• Homepage: https://whatsaaaa.github.io/ts-library-template/
• Size: 176 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# TypeScript Library Example

## Project setup

Make sure you have installed **volta**,

which will ensure you have the right version

of *node* and *yarn* for this project.

## Clone

Checkout a working copy of this project

```

git clone [email protected]:whatsaaaa/ts-library-template.git

```

enter the directory

```

cd ts-library-template

```

## Install dependencies

For this project the recommended package manager is `yarn`. Install 

dependencies by running

```

yarn

```

## Project documentation

This project is using `@microsoft/api-extractor` and `@microsoft/api-documenter`

in order to create API documentation. You can find the docs at next url: https://whatsaaaa.github.io/ts-library-template/

## Starting the project

```

yarn dev

```

## Linting the project

```

yarn lint

```

## Building the project

```

yarn build

```

## Testing the project

```

yarn test

```