https://github.com/rainbowatcher/ts-starter

lightweight typescript library starter template
https://github.com/rainbowatcher/ts-starter

Last synced: 12 days ago
JSON representation

lightweight typescript library starter template

• Host: GitHub
• URL: https://github.com/rainbowatcher/ts-starter
• Owner: rainbowatcher
• License: mit
• Created: 2023-04-11T03:16:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-03T04:56:01.000Z (14 days ago)
• Last Synced: 2024-11-03T05:23:56.417Z (14 days ago)
• Language: TypeScript
• Size: 657 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rainbowatcher/ts-starter/ci.yml)](https://github.com/rainbowatcher/ts-starter/actions)

![GitHub License](https://img.shields.io/github/license/rainbowatcher/ts-starter)

![GitHub package.json version](https://img.shields.io/github/package-json/v/rainbowatcher/ts-starter)

# TS-Starter

## 🚀Features

- Minimal install sized Dependencies.

- Eslint v9 rules default enable for `.js`/`.ts`/`.json`/`.md`/`.toml`/`.yaml`...etc.

- VSCode compatible eslint configuration.

- Cross platform CI configuration.

- Conventional commit message style lint.

- Smooth release experience.

- Auto Changelog generate.

- Complete package build configration.

- Automatic dependency upgrade by renovate.

## Usage

1. Clone this repository

```bash

npx degit https://github.com/rainbowatcher/ts-starter.git 

```

2. Install dependencies by using `pnpm install`

3. Global Replace `ts-starter` to your package name in project

4. Change the author and repository address in `package.json`

5. Change the author name in `LICENSE`

6. Clean up the `README.md`

7. Remove `renovate.json` or use your own one

## License

[MIT](./LICENSE) © Made by ❤️