Skip to content

A quick start template for a new TypeScript library πŸ’…πŸ»

License

Notifications You must be signed in to change notification settings

codex-team/typescript-lib-template

Repository files navigation

@codexteam/typescript-lib-template

A quick start template for a new TypeScript library

NPM version License

Features

  • πŸ’„ Yarn 4
  • πŸ›οΈ Yarn Workspaces
  • πŸ’Ž ESLint 9 with eslint-config-codex
  • πŸ₯ƒ Typescript 5
  • πŸ₯Š npx only-allow yarn
  • 🌢️ Tests with Vitest
  • πŸ€ GitHub Actions for test/lint/build/publish purposes

How to use

  1. Click here and fill setting for new repository
  2. Update root package package.json, change main package name
  3. Update "core" package package.json:
    1. Change name
    2. Adjust main, types, exports
  4. Change name of packages/core to your main package name
  5. Go to packages/utils and adjust its name or remove the package if you don't need it
  6. Change NPM package scope from workflow file or remove it
  7. Fill NPM_TOKEN and CODEX_BOT_WEBHOOK secrets in your repository or organization settings
  8. Start writing your new library!

About CodeX

CodeX is a team of digital specialists around the world interested in building high-quality open source products on a global market. We are open for young people who want to constantly improve their skills and grow professionally with experiments in cutting-edge technologies.

🌐 Join πŸ‘‹ Twitter Instagram
codex.so codex.so/join @codex_team @codex_team

About

A quick start template for a new TypeScript library πŸ’…πŸ»

Topics

Resources

License

Stars

Watchers

Forks