typestart2.0.0 • Public • Published
Typestart is a web/DOM library starter with these features:
- Written in Typescript
- Built-in demo with GitHub pages (
- main/module/types in
- Bundled as UMD (works as a module)
window.Library(works with CDNs)
- Test with Jest
- Build with Travis CI
- Clean with Prettier
⭐ Getting started
Clone and start your project:
git clone firstname.lastname@example.org:AnandChowdhary/typestartmv typestart my-library && cd my-librarysudo rm -r .git && git init
Find and replace "typestart" with your library name and "AnandChowdhary" with your GitHub username.
Setup GitHub Pages demo by going to Settings → GitHub Pages → Source → master branch /docs folder.
Start development server with HMR and prettier:
Build a production version:
🛠️ Using a Typestart library
Install the library as a dependency:
npm install typestart
Or, if you're using Yarn:
yarn add typestart
Then import the library:
And initialize it with an optional selector:
const typestart = "#heading";
You can also use a CDN:
💡 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.
Unlicense (public domain, do whatever you want)