https://github.com/yowainwright/typescript-lib-starter
[WIP] A batteries included TypeScript lib with React GH Dcos page in minutes
https://github.com/yowainwright/typescript-lib-starter
Last synced: 6 months ago
JSON representation
[WIP] A batteries included TypeScript lib with React GH Dcos page in minutes
- Host: GitHub
- URL: https://github.com/yowainwright/typescript-lib-starter
- Owner: yowainwright
- License: mit
- Created: 2022-08-05T05:55:14.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T21:05:17.000Z (almost 2 years ago)
- Last Synced: 2024-09-18T02:01:47.578Z (almost 2 years ago)
- Language: TypeScript
- Homepage:
- Size: 1.1 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# [WIP] Typescript Library Starter 📚
#### Typescript Library Starter (`typescript-lib-starter`)
A batteries included Typescript starter template for building a Typescript Library with maintenability and developer experience focus.
---
## Why should I use this?
This starter will help you build and release library fast!
#### There are a lot of templates for that. _Why this one?_
This starter works immediately but is built for maintainability!
- ✅ Developer experience is top consideration!
- ✅ Tools implemented to be interchangeable and extendable.
---
## Setup
1. Click the button to use this template.
1. Run `pnpm install`. _Configuration will happen automatically via an npm hook!_
## Features
Listed below are features implemented in this starter template:
### `src` Library/
- [Node 18](https://nodejs.org/de/blog/announcements/v18-release-announce/): Current Node
- [Typescript](https://www.typescriptlang.org/): Types
- [Vitest](https://vitest.dev/): Unit testing
- [Commander Cli](https://www.npmjs.com/package/commander): Library Execution
### `page/app` Landing/Docs Page
- [Vite](https://vitejs.dev/): Site builder
- [React](https://reactjs.org/): UI Framework
- [TailwindCSS](https://tailwindcss.com/): CSS
- [Daisy UI](https://daisyui.com/): Components
- [MDX](): Fast Documentation
### DevX
- [Turborepo](): Script runner, caching
- [Eslint](): Linting
- [Prettier](): Formatting
- [Commitlint](): Commit messages
- [Husky](): Git hooks
- [Lint-staged](): Lint staged files
- [Codependence](): Dependency management
---