https://github.com/matronator/vite-ts-lib-starter

A simple library template starter for Vite with TypeScript, Prettier, Vitest, Bun, Renovate and np.
https://github.com/matronator/vite-ts-lib-starter

boilerplate library-starter library-template starter-template template typescript-library typescript-library-boilerplate vite vite-library-mode vite-starter vite-starter-template vite-template vite-typescript

Last synced: 3 months ago
JSON representation

A simple library template starter for Vite with TypeScript, Prettier, Vitest, Bun, Renovate and np.

• Host: GitHub
• URL: https://github.com/matronator/vite-ts-lib-starter
• Owner: matronator
• License: mit
• Created: 2024-07-08T17:44:33.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-07-16T12:45:06.000Z (6 months ago)
• Last Synced: 2024-10-11T19:49:04.985Z (3 months ago)
• Topics: boilerplate, library-starter, library-template, starter-template, template, typescript-library, typescript-library-boilerplate, vite, vite-library-mode, vite-starter, vite-starter-template, vite-template, vite-typescript
• Language: TypeScript
• Homepage:
• Size: 848 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

• fucking-awesome-vite - vite-ts-lib-starter - Starter template for libraries with TypeScript, Bun, Vitest, Prettier, Renovate and np. (Get Started / Templates)
• awesome-vite - vite-ts-lib-starter - Starter template for libraries with TypeScript, Bun, Vitest, Prettier, Renovate and np. (Get Started / Templates)

README

        
# Vite TypeScript Library Starter

![Ping Tracker logo](.github/logo.png)

![NPM Version](https://img.shields.io/npm/v/package-name)

![NPM Downloads](https://img.shields.io/npm/dw/package-name)

![npm TypeScript version](https://img.shields.io/npm/dependency-version/package-name/dev/typescript)

![Tree shaking](https://badgen.net/bundlephobia/tree-shaking/package-name)

![Dependencies](https://badgen.net/bundlephobia/dependency-count/package-name)

![npm package minimized gzipped size](https://img.shields.io/bundlejs/size/package-name)

![Commits](https://badgen.net/github/commits/username/repository)

![Issues](https://img.shields.io/github/issues/username/repository.svg)

![License](https://img.shields.io/github/license/username/repository.svg)

![Follow](https://img.shields.io/github/followers/matronator.svg?style=social&label=Follow&maxAge=2592000)

![GitHub Sponsors](https://img.shields.io/github/sponsors/matronator)

A starter template to use for developing libraries with Vite and TypeScript.

## Tech-stack

-   [Bun](https://bunpkg.com/) - A package manager for the web (faster alternative to npm and yarn)

-   [Vite](https://vitejs.dev/) - A next-generation front-end tooling

-   [TypeScript](https://www.typescriptlang.org/) - A typed superset of JavaScript

-   [Vitest](https://vitest.dev/) - A test runner for Vite

-   [Prettier](https://prettier.io/) - An opinionated code formatter

-   [Renovate](https://www.mend.io/renovate/) - Automated dependency updates

-   [np](https://github.com/sindresorhus/np) - A better `npm publish`

## Installation

1. Clone this repository, or

2. Click on "Use this template" button, or

3. Download the repository as a ZIP file, or

4. Use [degit](https://github.com/Rich-Harris/degit), like this:

```

bunx degit matronator/vite-ts-lib-starter my-new-library

```

## After installation

1. Change the `package.json` file to match your library's name, description, author, etc.

2. Change the `outFile` field in the `dts-bundle-generator.config.js` file to match your library's name.

3. Replace the logo with your own.

4. Modify `FUNDING.yml` in the `.github` folder with your own values or remove it completely.

5. Replace the `README.md` file with your own.

6. Change the name in the `LICENSE.md` file.

7. Replace the `CHANGELOG.md` file with your own.

8. Start creating your library in the `src` folder.

9. Write some tests in the `tests` folder.

10. When you're ready to publish your library, run `npm run build` to generate the production files.

11. Publish your library to npm with either `npm publish`, or `npm run release` to use `np` for a better publishing experience.