https://github.com/codex-team/typescript-lib-template

A quick start template for a new TypeScript library
https://github.com/codex-team/typescript-lib-template

Last synced: 4 months ago
JSON representation

A quick start template for a new TypeScript library

• Host: GitHub
• URL: https://github.com/codex-team/typescript-lib-template
• Owner: codex-team
• License: mit
• Created: 2021-02-11T08:45:07.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-02-12T14:01:39.000Z (over 4 years ago)
• Last Synced: 2024-04-24T13:44:48.498Z (about 1 year ago)
• Language: TypeScript
• Size: 106 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @codexteam/typescript-lib-template

A quick start template for a new TypeScript library

[![NPM version](https://img.shields.io/npm/v/@codexteam/typescript-lib-template?style=flat-square)](https://www.npmjs.com/package/@codexteam/typescript-lib-template)

[![License](https://img.shields.io/npm/l/@codexteam/typescript-lib-template?style=flat-square)](https://www.npmjs.com/package/@codexteam/typescript-lib-template)

## Features 

- 💄 Yarn 4

- 🛍️ Yarn Workspaces

- 💎 ESLint 9 with [eslint-config-codex](http://github.com/codex-team/eslint-config/)

- 🥃 Typescript 5

- 🥊 npx only-allow yarn

- 🌶️ Tests with [Vitest](https://vitest.dev)

- 🍀 GitHub Actions for test/lint/build/publish purposes

## How to use

1. Click [here](https://github.com/codex-team/typescript-lib-template/generate) 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`

5. 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

3. Change NPM package scope from [workflow file](./.github/workflows/main.yml) or remove it

4. Fill `NPM_TOKEN` and `CODEX_BOT_WEBHOOK` secrets in your repository or organization settings

5. 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](https://codex.so/join) for young people who want to constantly improve their skills and grow professionally with experiments in cutting-edge technologies.

| 🌐 | Join  👋  | Twitter | Instagram |

| -- | -- | -- | -- |

| [codex.so](https://codex.so) | [codex.so/join](https://codex.so/join) |[@codex_team](http://twitter.com/codex_team) | [@codex_team](http://instagram.com/codex_team/) |