/typescript-starter

🐜 Minimalist starting point for your next TypeScript project

Primary LanguageTypeScript

🐜 typescript-starter

Minimalist starting point for your next TypeScript project.

  • 🧩 Latest TypeScript
  • 🤹 Testing using Jest
  • 🚚 Built using unbuild
  • ✅ Type definitions with untyped
  • 🌈 Complete GitHub CI ready (test, build, publish)
  • 🏎 Edit variables, implement, test, publish

Setup

  • Update package.json
  • Add NPM_AUTH_TOKEN to GitHub repository secrets
  • Implement from index.ts
  • Build with yarn build
  • Bump package.json > version key to make a release from GitHub action

Commands

Build the package:

yarn build

Build with watcher:

yarn dev

Lint the package:

yarn link

Run test suite:

yarn test

Test typings:

yarn test:types

Contributing

You are more than welcome to improve this starter template.

Just submit your changes via pull request and I will review them before merging.

If you are making a fix on the template, you can use the main branch and send a pull request.

If you are adding a new features, please create a new branch with a name describing your feature (my-new-feature), push to your branch and then submit a pull request.