https://github.com/Sunny-117/ts-lib-vite

A foundation for developing front-end utility libraries using Vite and TypeScript.
https://github.com/Sunny-117/ts-lib-vite

Last synced: 4 months ago
JSON representation

A foundation for developing front-end utility libraries using Vite and TypeScript.

• Host: GitHub
• URL: https://github.com/Sunny-117/ts-lib-vite
• Owner: Sunny-117
• Created: 2023-11-19T12:10:41.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-29T06:05:41.000Z (8 months ago)
• Last Synced: 2024-06-30T09:18:19.190Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 240 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-Zh.md

Awesome Lists containing this project

README

        
# ts-lib-vite

[English](./README.md)

一个基于 Vite 和 TypeScript 的前端实用工具库开发基础。

## 项目结构

Monorepo: 以单一仓库的形式组织，有利于代码管理。

## 开发规范

- 代码风格: 使用 ESLint 和 Prettier 强制执行，确保代码一致和清晰。

- 版本管理: 遵循语义化版本规范进行版本控制。

- 提交指南: 通过 Git 提交规范确保版本历史清晰和有意义。

- Pre-commit 钩子: 使用 Husky 强制执行 pre-commit 钩子，保障代码质量和一致性。

## 技术栈

语言: 使用 TypeScript 进行类型安全和高效的开发。

## 构建工具

- Vite: 作为主要构建工具，用于快速和优化的开发。

- Rollup: 用于额外的打包和优化。

## 入门指南

要开始开发，请按照以下步骤进行：

1. 克隆仓库:

```shell

git clone https://github.com/Sunny-117/ts-lib-vite.git

cd ts-lib-vite

```

2. 安装依赖:

```shell

pnpm run dev

```

```shell

pnpm run dev

```

这将启动开发服务器。

4. 构建项目:

```shell

pnpm run build

```

这将生成用于生产的构建文件。

## 贡献指南

如果你想为这个项目做出贡献，请遵循我们的贡献指南。我们欢迎贡献并感谢您的帮助！

## 许可证

本项目基于 MIT 许可证。