https://github.com/thecodetherapy/boilerplate-ts
A minimalistic TypeScript boilerplate for sandboxing quick lab experiments
https://github.com/thecodetherapy/boilerplate-ts
Last synced: about 2 months ago
JSON representation
A minimalistic TypeScript boilerplate for sandboxing quick lab experiments
- Host: GitHub
- URL: https://github.com/thecodetherapy/boilerplate-ts
- Owner: TheCodeTherapy
- Created: 2024-04-25T12:35:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T16:11:33.000Z (about 1 year ago)
- Last Synced: 2025-04-15T19:49:01.902Z (12 months ago)
- Language: TypeScript
- Size: 105 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# boilerplate-ts
This is a minimal `TypeScript` boilerplate that uses `Vite` as its build system.
The motivation behind this was to obtain a clean slate to prototype quick lab experiments without the hassle of configuring a new project but with a specific particularity in mind.
As with any Vite project, files in the `public` directory will be copied to the `dist` directory when building the project. However, the aim of this boilerplate was to produce a build consisting of a single self-contained HTML file with all the project's assets inlined.
That is achieved by a few custom plugins on the `vite.config.ts` configuration, which inlines graphic assets like SVG files into the built JavaScript code. The same is done with other graphic assets' formats like PNG or JPG, however, converting them into a `base64` data string (which will have, as a side-effect, an average of 33% increase in size as a "price paid" to have it inlined into the single HTML file).
The main goal of this particular build method is not to have the tiniest possible build by brushing out all possible bits (like I'd do for demoscene purposes) but to create a small build capable of being executed locally on any machine (just by double-clicking the file and opening it with your favourite/default browser) despite having built-in graphical assets, without relying on any type of local web server while complying with browsers's security policies to load local assets.