Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blankparticle/typescript-lib-starter
A template repo for starting a typescript library.
https://github.com/blankparticle/typescript-lib-starter
biomejs changesets starter template tsup typescript
Last synced: 4 days ago
JSON representation
A template repo for starting a typescript library.
- Host: GitHub
- URL: https://github.com/blankparticle/typescript-lib-starter
- Owner: BlankParticle
- License: mit
- Created: 2024-02-11T12:29:27.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-02-11T12:34:53.000Z (9 months ago)
- Last Synced: 2024-10-17T19:20:51.051Z (22 days ago)
- Topics: biomejs, changesets, starter, template, tsup, typescript
- Language: TypeScript
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ✨ Typescript Lib Starter
A template for creating TypeScript libraries with ease.
---
## ❄️ Installation
First install the package using a package manager of your choice.
```bash
# using npm
npm install
# or pnpm
pnpm install
# or bun
bun add
```
## 🚀 Usage
### 🐛 Reporting Bugs
If you encounter any bugs, please report them in the [Issues](https://github.com/BlankParticle/typescript-lib-starter/issues).
### 🎋 Adding new features
You need to first [fork](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#about-forking) this repository and then [clone](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#cloning-a-fork) it to your local machine.
```bash
git clone https://github.com/[your-username]/typescript-lib-starter
cd typescript-lib-starter
```
Now you need to create a new branch for your changes. For features, you may want to use `feat/[feature-name]` as the branch name.
```bash
git checkout -b feat/[feature-name]
```
Now you can make your changes. After you are done, you need to commit your changes.
```bash
git add .
git commit -m "feat: ✨ My Awesome feature"
```
Now you need to push the changes to your forked repository.
```bash
git push origin feat/[feature-name]
```
Now you need to create a [Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) to the original repository. And you are done!
We will review your changes and merge them if everything looks good.
### 💸 Sponsorship
If you find this plugin useful, please consider [sponsoring me](https://github.com/sponsors/BlankParticle). This will help me spend more time on these projects.
# 📜 License
This project is licensed under the [MIT License](https://github.com/BlankParticle/typescript-lib-starter/blob/main/LICENSE).