https://github.com/labelementary/package-essential
Package Essential - An Essential Template to get started with TypeScript based package with all the essentials included.
https://github.com/labelementary/package-essential
biomejs changesets husky tsup typescript
Last synced: 10 months ago
JSON representation
Package Essential - An Essential Template to get started with TypeScript based package with all the essentials included.
- Host: GitHub
- URL: https://github.com/labelementary/package-essential
- Owner: labelementary
- Created: 2024-07-30T13:06:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-27T11:58:50.000Z (about 1 year ago)
- Last Synced: 2025-02-02T02:33:57.112Z (12 months ago)
- Topics: biomejs, changesets, husky, tsup, typescript
- Language: TypeScript
- Homepage:
- Size: 131 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Package Essential
Package Essential - An Essential Template to get started with TypeScript based package with all the essentials included...
## Features
- 💻 Language: [TypeScript](https://www.typescriptlang.org/) - Typed superset of JavaScript
- 📦 Tsup: [Tsup](https://github.com/egoist/tsup) - The next generation frontend build tool
- 🧹 Linting and Formatting: [Biome.js](https://biomejs.dev/) - Fast and customizable linter and formatter
- ⚙️ Build: Github Actions - Automated workflows for CI/CD
- 🛠 Commit: [Husky](https://typicode.github.io/husky/) - Git hooks made easy
- 📦 Package: [pnpm](https://pnpm.io/) - Fast, disk space efficient package manager
## Getting Started
1. Clone the repository
2. Install dependencies: `npm install` or `pnpm install` or `yarn install`
## Contributing
Contributions are always welcome! Please follow these steps:
1. Fork the repository
2. Create a new branch: `git checkout -b feature/your-feature-name`
3. Make your changes and commit them: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin feature/your-feature-name`
5. Submit a pull request
For major changes, please open an issue first to discuss what you would like to change.