typescript-webpack-starter - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #llm #go #golang #docker #java #awesome #vue #awesome-list #security #mcp

typescript-webpack-starter

(★ 374)

⚡ create-ts-lib: A Starter Kit and a CLI to create your TypeScript / ES6 module bundled by Webpack without thinking about build or unit tests configurations. 🏠

파일 탐색기

최종 버전 다운로드 (.zip)

- config.yml
- launch.json
- - CHANGELOG.md
  - createTsLib.js
  - index.js
  - package-lock.json
  - package.json
  - README.md
- - .gitignore
  - CHANGELOG.md
  - package-lock.json
  - package.json
- publish.sh
.gitignore
_config.yml
CHANGELOG.md
CONTRIBUTING.md
jsconfig.json
lerna.json
LICENSE
package-lock.json
package.json
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/nobrainr/typescript-webpack-starter

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd typescript-webpack-starter

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

cd my-typescript-lib && npm start

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# create-ts-lib [![Backers on Open Collective](https://opencollective.com/typescript-webpack-starter/backers/badge.svg)](https://raw.githubusercontent.com/nobrainr/typescript-webpack-starter/master/) [![Sponsors on Open Collective](https://opencollective.com/typescript-webpack-starter/sponsors/badge.svg)](https://raw.githubusercontent.com/nobrainr/typescript-webpack-starter/master/) [![CircleCI](https://img.shields.io/circleci/project/github/nobrainr/typescript-webpack-starter.svg)](https://circleci.com/gh/nobrainr/workflows/typescript-webpack-starter/tree/master) [![Npm Package](https://img.shields.io/npm/v/create-ts-lib.svg)](https://www.npmjs.com/package/create-ts-lib)

![](https://s3.us-east-2.amazonaws.com/typescript-webpack-starter/create-ts-lib.gif)

## Quick Start

You can execute the `create-ts-lib` CLI using [`npx`](https://github.com/zkat/npx) or by installing it globally with `npm i -g create-ts-lib`.

```sh
# Use NPX or npm install -g create-ts-lib to install it as a global package
npx create-ts-lib@latest my-typescript-lib
cd my-typescript-lib && npm start
```

### Build and Serve it

- Browse http://localhost:3000/ to see your bootstrapped module.
- A bundle is created under `/dist` folder.
- Create a minified bundle with `npm run build`.

## Features

You **don’t** need to install or configure tools like `Webpack`, `Typescript`, `Karma` or `Jasmine`.<br>
They are preconfigured so that you can focus on the code, but as a starter kit you still can modify all the configuration files.

- [x] (Application Type) [Typescript 3](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-0.html)
- [x] (Bundler) [Webpack 4](https://webpack.js.org/)
- [x] [Karma](https://karma-runner.github.io/1.0/index.html), [Jasmine](https://jasmine.github.io/)

### Create a Typescript project

```sh
# Use NPX or npm install -g create-ts-lib to install it as a global package
npx create-ts-lib@latest my-typescript-lib
cd my-typescript-lib && npm start
```

Calling `create-ts-lib` with `my-typescript-lib` as an argument creates a directory `my-typescript-lib` inside the current directory.<br>
Inside that directory, the initial file structure of the project is generated with all the devDependencies installed.

```sh
my-typescript-lib
├── node_modules
├── src
│   └── index.html
│   └── index.ts
│   └── MyLibrary.ts
│   └── MyLibrary.spec.ts
├── tests
│    └── unit
│        └── spec-bundle.js
├── README.md
├── package.json
├── .gitignore
├── karma.conf.js
├── tsconfig.json
├── tslint.json
└── webpack.config.js
```

No configuration or complicated folder structures, just the files you need to start your app / package / module.<br>

### `npm start` or `npm run server:prod`

Runs the app in development / production mode using Webpack dev server.
Open [http://localhost:3000](http://localhost:3000) 🎉 to view it in the browser.

### `npm test`

Runs the unit tests using Karma as test runner and Jasmine as testing framework.

### `npm run build` or `npm run build:prod`

Creates a bundle into the `dist` folder:

```sh
dist
├── MyLibrary.d.ts # - Example of a 'd.ts' declaration file
├── app.bundle.js # - Main bundle of the application. name from webpack.config
├── app.bundle.js.map # - Sourcemap
├── index.d.ts
└── index.html # - html page referencing app.bundle.js
```

## Development

We'd love to have your helping hand on `create-ts-lib`! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.

## Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="graphs/contributors"><img src="https://opencollective.com/typescript-webpack-starter/contributors.svg?width=890&button=false" /></a>

## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/typescript-webpack-starter#backer)]

<a href="https://opencollective.com/typescript-webpack-starter#backers" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/backers.svg?width=890"></a>

## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/typescript-webpack-starter#sponsor)]

<a href="https://opencollective.com/typescript-webpack-starter/sponsor/0/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/typescript-webpack-starter/sponsor/1/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/typescript-webpack-starter/sponsor/2/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/typescript-webpack-starter/sponsor/3/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/typescript-webpack-starter/sponsor/4/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/typescript-webpack-starter/sponsor/5/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/typescript-webpack-starter/sponsor/6/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/typescript-webpack-starter/sponsor/7/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/typescript-webpack-starter/sponsor/8/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/typescript-webpack-starter/sponsor/9/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/9/avatar.svg"></a>