Skip to content

Commit

Permalink
chore: change package name
Browse files Browse the repository at this point in the history
  • Loading branch information
productdevbook committed Nov 13, 2023
1 parent a9225eb commit a53a4d4
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 37 deletions.
41 changes: 6 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,14 @@
# Typescript Bundle Template
# Easypanel Api

![Typescript Bundle Template](https://github.com/productdevbookcom/assets/blob/main/ts-bundle-template.jpg?raw=true)
[easypanel](https://easypanel.io)


This is a template for creating a Typescript bundle. It is based on the [Typescript](https://www.typescriptlang.org/) compiler with the [Tsup](https://github.com/egoist/tsup) bundler.
## Installation

## Features
```bash
pnpm install easypanel
```

- [x] [Typescript](https://www.typescriptlang.org/)
- [x] [Tsup](https://github.com/egoist/tsup)
- [x] [ESLint](https://eslint.org/) with [Antfu's ESLint Config](https://github.com/antfu/eslint-config)
- [x] [Bumpp](https://github.com/antfu/bumpp) github changelog generator
- [x] [Vitest](https://vitest.dev/)
- [x] [Pnpm](https://pnpm.io/)
- [x] [GitHub Actions]()
- [x] [NPM Local Registry]()
- [x] [Renovate]()


## Usage

1. To use this template, click the "Use this template" button above.
2. Clone the repository to your local machine.
3. Run `pnpm install` to install the dependencies.
4. Run `pnpm build` to build the bundle.
5. Run `pnpm start` to start the bundle.
6. Run `pnpm lint` to lint the code. (You can also run `pnpm lint:fix` to fix the linting errors.)
7. Run `pnpm test` to run the tests. (You can also run `pnpm test:watch` to run the tests in watch mode.)
8. Run `pnpm release` to bump the version. Terminal will ask you to select the version type. And then it will automatically commit and push the changes. GitHub Actions will automatically publish git tags. NPM local registry will automatically publish the package.

## Configuration

### Renovate

[Setup Github App](https://github.com/apps/renovate) for Renovate.

### TS Config Base

(tsconfig.json)[https://github.com/tsconfig/bases/tree/main/bases] is used as the base config for the Typescript compiler.

## Sponsors

Expand Down
2 changes: 1 addition & 1 deletion playground/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
"test": "echo \"Error: no test specified\" && exit 1"
},
"devDependencies": {
"ts-bundle-template": "workspace:^"
"easypanel": "workspace:^"
}
}
2 changes: 1 addition & 1 deletion pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a53a4d4

Please sign in to comment.