Skip to content

Add archetype manifest for charmix #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@ yarn esbuild-browser
* Take a look at all the scripts in [`package.json`](https://github.com/metachris/typescript-boilerplate/blob/master/package.json)
* For publishing to npm, use `yarn publish` (or `npm publish`)

You may use this boilerplate as static [charmix archetype](https://github.com/vitonsky/charmix)

```bash
# Install archetype
charmix add -t git https://github.com/metachris/typescript-boilerplate.git

# Generate project
charmix use -d ./projectDirectory typescript-boilerplate
```

## esbuild

[esbuild](https://esbuild.github.io/) is an extremely fast bundler that supports a [large part of the TypeScript syntax](https://esbuild.github.io/content-types/#typescript). This project uses it to bundle for browsers (and Node.js if you want).
Expand Down
8 changes: 8 additions & 0 deletions archetype.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "typescript-boilerplate",
"type": "staticTemplate",
"files": {
"include": "./*",
"exclude": ["./archetype.json"]
}
}