Skip to content

k1de/ts-minimal-kit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ts-minimal-kit

Minimal TypeScript kit: strict typing, clean setup, ready to code.

Project Structure

ts-minimal-kit/
├── src/
│   └── app.ts              # Main application file
├── dist/                   # Compiled files (created automatically)
├── .gitignore              # Git ignored files
├── .npmignore              # npm ignored files
├── .prettierrc             # Prettier configuration
├── package.json            # Project settings and dependencies
├── tsconfig.json           # TypeScript configuration
└── README.md               # This file

How to Use This Kit

⚡ Method 1: CLI Installer (Recommended)

npm install -g ts-minimal-kit-cli
ts-minimal-kit my-project

Automatically clones template, removes git history, initializes new repository, installs dependencies.

🎯 Method 2: GitHub Template

  1. Click the "Use this template" button on the repository page
  2. Create a new repository based on the kit
  3. Clone your new repository:
    git clone https://github.com/your-username/your-project.git
    cd your-project

📦 Method 3: degit

npx degit k1de/ts-minimal-kit my-project
cd my-project

🔄 Method 4: Git clone + Initialize new repository

git clone https://github.com/k1de/ts-minimal-kit.git my-project
cd my-project
npm run degit    # Remove git history
git init         # Initialize new repository

📥 Method 5: Download ZIP

  1. Download ZIP archive from GitHub
  2. Extract to desired folder
  3. Rename folder to your project name

Quick Start

Setup:

  • Install dependencies:
npm install

Development:

  • Watch and compile: npm run dev
  • Build: npm run build
  • Run: npm run start
  • Build and run: npm run build:start

Utilities:

  • Clean: npm run clean
  • Remove git history: npm run degit

TypeScript Update

Recommendation: Update TypeScript to the latest version:

npm install -D typescript@latest @types/node@latest

This will install the current stable version of TypeScript in your project and write it to package.json.

Check current version:

npx tsc --version

TypeScript Settings

  • Strict typing enabled
  • Source maps for debugging
  • Declaration files for libraries
  • Modern ESNext features
  • CommonJS modules support

License

ISC © tish

About

Minimal TypeScript kit: strict typing, clean setup, ready to code

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published