https://github.com/permafrost-dev/vite-react-tailwind-ts-electron-skeleton
Vite/React/Tailwind/Typescript/Electron Starter Template
https://github.com/permafrost-dev/vite-react-tailwind-ts-electron-skeleton
Last synced: over 1 year ago
JSON representation
Vite/React/Tailwind/Typescript/Electron Starter Template
- Host: GitHub
- URL: https://github.com/permafrost-dev/vite-react-tailwind-ts-electron-skeleton
- Owner: permafrost-dev
- License: mit
- Created: 2022-09-29T23:28:00.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-27T02:11:14.000Z (over 2 years ago)
- Last Synced: 2025-01-23T15:32:20.383Z (over 1 year ago)
- Language: JavaScript
- Size: 530 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# package-skeleton
---
Template Setup: run `node configure-package.js` to configure.
{{package.description}}
---
### `Vite + React + Tailwind + Typescript Starter ⚡`
This starter template also includes:
- React Router
- MobX
- [Inter var font](https://github.com/rsms/inter) (self-hosted, woff2, v3.19, with 'preload' attr, check out index.html)
- [TailwindCSS JIT](https://tailwindcss.com/docs/just-in-time-mode) mode by default introduced in Tailwind CSS v2.1 (in preview!)
- [Headless UI](https://headlessui.dev/react/menu) - unstyled, fully accessible UI components, designed to integrate beautifully with Tailwind CSS
- [Heroicons](https://github.com/tailwindlabs/heroicons#react) - beautiful hand-crafted SVG icons,
by the makers of Tailwind CSS
First-party plugins needed for Tailwind UI:
- [tailwindcss/forms](https://github.com/tailwindlabs/tailwindcss-forms)
- [tailwindcss/typography](https://github.com/tailwindlabs/tailwindcss-typography)
- [tailwindcss/line-clamp](https://github.com/tailwindlabs/tailwindcss-line-clamp)
- [tailwindcss/aspect-ratio](https://github.com/tailwindlabs/tailwindcss-aspect-ratio)
## Getting Started 🚀
First, configure the project:
```sh
node configure-package.js
```
npm:
```sh
npm install
npm run dev
npm run build
npm run serve
```
...or start the Electron app:
```sh
npm run start:el
```
## 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}})
- [web2033](https://github.com/web2033/vite-vue3-tailwind-starter)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.