Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 1.24 KB

README.md

File metadata and controls

81 lines (57 loc) · 1.24 KB
Raw

Getting started

clone the repo and detach from

git clone https://github.com/romanzy-1612/modern-ts-lib-starter.git PROJECTNAME
cd PROJECTNAME
rm -rf ./.git

customize this template

node init-template.js

install dependencies and run tests

pnpm install
pnpm test

Whats included

  • Vite/tsc bundling
  • Vitest unit testing
  • Playwright e2e testing
  • Minimal eslint and prettier configuration
  • Easy templating for customized npm publishable repo
  • Working ? github actions for testing

Create another example

Create new vite project and install your library

pnpm create vite example2
cd example2
pnpm install placeholder-lib-name

Use your library as folloing:

import { DummyClass } from 'placeholder-lib-name/src';
console.log(DummyClass);

TODOS

[] Cache playwright deps (https://playwrightsolutions.com/playwright-github-action-to-cache-the-browser-binaries/)

delete above here to start writing your README

placeholder-lib-name

<>

Features

Installation

npm

npm install placeholder-lib-name

yarn

yarn add placeholder-lib-name

pnpm

pnpm install placeholder-lib-name

Usage

Examples

See more examples here