https://github.com/permafrost-dev/typescript-project-skeleton-esbuild-jest

project template w/ Typescript, ESLint, Prettier, Jest, ESBuild & automated dependency updates
https://github.com/permafrost-dev/typescript-project-skeleton-esbuild-jest

eslint jest prettier project-skeleton project-template project-template-repo repository-template template template-repository typescript workflow-automation

Last synced: about 2 months ago
JSON representation

project template w/ Typescript, ESLint, Prettier, Jest, ESBuild & automated dependency updates

• Host: GitHub
• URL: https://github.com/permafrost-dev/typescript-project-skeleton-esbuild-jest
• Owner: permafrost-dev
• License: mit
• Created: 2021-01-09T16:41:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-29T09:07:39.000Z (about 2 months ago)
• Last Synced: 2024-07-29T12:40:46.867Z (about 2 months ago)
• Topics: eslint, jest, prettier, project-skeleton, project-template, project-template-repo, repository-template, template, template-repository, typescript, workflow-automation
• Language: JavaScript
• Homepage:
• Size: 513 KB
• Stars: 20
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: .github/SECURITY.md

Awesome Lists containing this project

• awesome-esbuild - typescript-project-skeleton-esbuild-jest - Template with the latest versions of Typescript, ESBuild, Jest, ESLint & Prettier. (Templates)

README

        
# package-skeleton

---



    



## Description

This repository is a starter template for NodeJS projects using the latest versions of TypeScript, ESBuild, ESLint, Prettier, and Jest. Use it to create NPM packages, CLI applications, and more.

It also optionally uses [Madge](https://github.com/pahen/madge) to visualize connections between classes and files within your project.

Want to use `.env` files in your project? This will configure it automatically, if you want it to.

Want to use a configuration file in your project? This will configure it automatically, too, if you ask it to.

## Template Setup

To configure, run:

```bash

node configure-package.js

```

The configure script will ask you a series of questions that will customize the template with values such as your name, GitHub username, email address, use of optional packages, and more.

Some of the default values are automatically determined based on your git configuration, but you may change any of the values when prompted.

{{package.description}}

## Setup

```bash

npm install

npm run dev

```

## Testing

`package-skeleton` uses Jest for unit tests. To run the test suite:

`npm run test`

---

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

-   [{{package.author.name}}](https://github.com/{{package.author.github}})

-   [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.