Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thi-ng/tpl-umbrella-zig
Minimal thi.ng/umbrella browser project template for hybrid TypeScript & Zig apps, using thi.ng/wasm-api for bridging both worlds and Vite as dev tool/server & bundler...
https://github.com/thi-ng/tpl-umbrella-zig
template-repository thing-umbrella typescript wasm webassembly zig
Last synced: 3 months ago
JSON representation
Minimal thi.ng/umbrella browser project template for hybrid TypeScript & Zig apps, using thi.ng/wasm-api for bridging both worlds and Vite as dev tool/server & bundler...
- Host: GitHub
- URL: https://github.com/thi-ng/tpl-umbrella-zig
- Owner: thi-ng
- License: mit
- Created: 2022-11-24T22:14:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T11:41:40.000Z (10 months ago)
- Last Synced: 2024-04-22T12:26:04.378Z (10 months ago)
- Topics: template-repository, thing-umbrella, typescript, wasm, webassembly, zig
- Language: Zig
- Homepage: https://thi.ng/umbrella
- Size: 252 KB
- Stars: 15
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# tpl-umbrella-zig
This is a bare-bones project template for hybrid
[TypeScript](https://www.typescriptlang.org/) & [Zig](https://ziglang.org) apps,
using
[thi.ng/wasm-api](https://github.com/thi-ng/umbrella/tree/develop/packages/wasm-api)
related infrastructure for bridging both worlds, and using
[Vite](https://vitejs.dev/) as dev tool/server & bundler...
Edit/delete everything as you see fit, see linked package readme files for
further details & please submit an issue if you spot anything wrong! Thanks!
## Getting started
Please consult the [GitHub
documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
to learn more about template repos. Once you cloned the repo, proceed as
follows:
```bash
# git clone ...
cd
# download & install all dependencies (can also use npm)
yarn install
# start dev server & open in browser
yarn start
# regenerate shared types (see thi.ng/wasm-api-bindgen)
yarn build:types
# production build
yarn build
# preview latest production build
yarn preview
```
## Requirements
This template is configured for Zig version v0.12.0 or newer, which includes
several breaking changes to the earlier build system. You can download the
latest version from the Zig website or (my own preferred method) using
[asdf](https://asdf-vm.com/) to install it (even just locally for this project):
```bash
# asdf supports multiple versions of a tool, here to install latest dev version
asdf install zig 0.12.0
# global use of that version
asdf global zig 0.12.0
# only use that version in this project (already pre-configured)
asdf local zig 0.12.0
```
- [Zig](https://ziglang.org) v0.12.0 or newer versions (see
[comments](https://github.com/thi-ng/umbrella/blob/develop/packages/wasm-api/README.md#using-the-zig-build-system))
- [Binaryen](https://github.com/WebAssembly/binaryen)
Please see the comments in
[build.zig](https://github.com/thi-ng/tpl-umbrella-zig/blob/main/build.zig) for
more details...
## Notes
This template pulls in more dependencies than needed for the runtime of your
actual app. Most of these additional packages are only required by the
[@thi.ng/wasm-api-bindgen](https://github.com/thi-ng/umbrella/tree/develop/packages/wasm-api-bindgen)
CLI tool to generate source code for the types shared between the WASM/JS
side... Feel free to remove that package if you're not making use of code
generation.
## License
This project is licensed under the MIT License. See LICENSE.txt
© 2022 - 2024 Karsten Schmidt