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

A template for building a library or application with Typescript, Vite, ESLint, Prettier, and some other nice-to-have features.
https://github.com/permafrost-dev/project-skeleton-typescript-vite-jest

eslint library-template prettier template template-repository typescript vite

Last synced: 30 days ago
JSON representation

A template for building a library or application with Typescript, Vite, ESLint, Prettier, and some other nice-to-have features.

• Host: GitHub
• URL: https://github.com/permafrost-dev/project-skeleton-typescript-vite-jest
• Owner: permafrost-dev
• License: mit
• Created: 2023-12-21T15:57:45.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-21T18:34:36.000Z (2 months ago)
• Last Synced: 2024-10-22T10:30:16.821Z (2 months ago)
• Topics: eslint, library-template, prettier, template, template-repository, typescript, vite
• Language: JavaScript
• Homepage: https://permafrost.dev/open-source
• Size: 295 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• 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

README

        
# package-skeleton

---



    



## Description

This repository is a starter template for NodeJS projects using the latest versions of TypeScript, Vite, ESLint, Prettier, and Jest. Use it to create NPM packages/libraries, React/Vue/Svelte applications or component libraries, and more.

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

## 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.