https://github.com/jellydn/pkg-cli-simple-app
Demo pkg app
https://github.com/jellydn/pkg-cli-simple-app
Last synced: 6 months ago
JSON representation
Demo pkg app
- Host: GitHub
- URL: https://github.com/jellydn/pkg-cli-simple-app
- Owner: jellydn
- Created: 2022-07-16T23:25:09.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-09T18:01:26.000Z (6 months ago)
- Last Synced: 2025-04-09T19:21:11.569Z (6 months ago)
- Language: TypeScript
- Size: 3.08 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Welcome to pkg-cli-simple-app 👋
[](https://www.npmjs.com/package/pkg-cli-simple-app)
[](#)
[](https://twitter.com/jellydn)
> Typescript starter project
[![ITMan - Tip #22 - Package your Node.js project into an executable [Vietnamese]](https://i.ytimg.com/vi/WdjdtqqDIkc/hqdefault.jpg)](https://www.youtube.com/watch?v=WdjdtqqDIkc)
The binary file will be published at action artifacts. E.g:
https://github.com/jellydn/pkg-cli-simple-app/actions/runs/2683655930
## Features
- 📦️ [pkg](https://github.com/vercel/pkg) Package your Node.js project into an executable.
- 📦 🍣 [pkgroll](https://github.com/privatenumber/pkgroll) - Zero-config JS bundler for ESM, CommonJS, and .d.ts outputs
- 🎨 [vitest](https://vitest.dev/) - Blazing Fast Unit Test Framework
## Install
```sh
yarn install
```
## Usage
```sh
yarn build
```
## Package into an executable
```sh
yarn pkg
```
## Example
```sh
yarn example
```
## Run tests
```sh
yarn test
```
## Linter
```sh
code --install-extension samverschueren.linter-xo
```
## Author
👤 **Huynh Duc Dung**
- Website: https://productsway.com/
- Twitter: [@jellydn](https://twitter.com/jellydn)
- Github: [@jellydn](https://github.com/jellydn)
## Show your support
Give a ⭐️ if this project helped you!
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_