Skip to content

Commit

Permalink
docs(README): introduction and features
Browse files Browse the repository at this point in the history
  • Loading branch information
dorayx committed Sep 2, 2023
1 parent 6b35804 commit b4569b4
Showing 1 changed file with 26 additions and 8 deletions.
34 changes: 26 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,27 @@
# _opinionated_ TypeScript Template
# _opinionated_ Vite-TypeScript Template

Since I like to create minimal viable products from time to time, having a personal boilerplate for TypeScript projects can boost efficiency,
and so I've created this repo as a starting point for my future projects.
This template is opinionated, and it is not meant to be a one-size-fits-all solution.
It is meant to be a starting point for my personal projects to bootstrap development, as I like to create minimal viable products from time to time.

## Tooling
## Features

**Package Manager**
- ✅ TypeScript v5
- ✅ Vite + Vitest
- ✅ Linters
- ✅ Code Generator
- ✅ Semantic Release
- ✅ GitHub Actions
- ❌ Monorepo

- [Yarn](https://yarnpkg.com/) _(v3)_
- Doc: [Zero-installs](https://www.npmjs.com/package/vite-tsconfig-paths)
**Use Cases**

- ✅ TypeScript Application
- ❌ TypeScript Library
- ❌ UI Component Library

## Tooling

This template is configured with the following tools:

**Compiler & Bundler**

Expand All @@ -17,6 +30,11 @@ and so I've created this repo as a starting point for my future projects.
- Plugin: [vite-tsconfig-paths](https://www.npmjs.com/package/vite-tsconfig-paths)
- Plugin: [vite-plugin-dts](https://www.npmjs.com/package/vite-plugin-dts)

**Package Manager**

- [Yarn](https://yarnpkg.com/) _(v3)_
- Doc: [Zero-installs](https://www.npmjs.com/package/vite-tsconfig-paths)

**Testing**

- [Vitest](https://vitest.dev/)
Expand Down Expand Up @@ -46,7 +64,7 @@ and so I've created this repo as a starting point for my future projects.
- Additional Plugin: [semantic-release-yarn](https://github.com/hongaar/semantic-release-yarn)
- Additional Plugin: [@semantic-release/changelog](https://github.com/semantic-release/changelog)

## Development
## Development Conventions

### Branches

Expand Down

0 comments on commit b4569b4

Please sign in to comment.