https://github.com/mbasso/asm-dom-boilerplate
A simple boilerplate to start using asm-dom without configuration.
https://github.com/mbasso/asm-dom-boilerplate
asmjs vdom vdom-library virtual-dom wasm webassembly
Last synced: 3 months ago
JSON representation
A simple boilerplate to start using asm-dom without configuration.
- Host: GitHub
- URL: https://github.com/mbasso/asm-dom-boilerplate
- Owner: mbasso
- License: mit
- Created: 2018-02-15T15:27:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-24T16:39:15.000Z (almost 2 years ago)
- Last Synced: 2025-02-27T00:04:29.968Z (3 months ago)
- Topics: asmjs, vdom, vdom-library, virtual-dom, wasm, webassembly
- Language: Makefile
- Homepage:
- Size: 16.6 KB
- Stars: 54
- Watchers: 4
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# asm-dom-boilerplate
A simple boilerplate to start using [asm-dom](https://github.com/mbasso/asm-dom) without configuration.
This includes:
- `asm-dom`
- `CPX support: JSX like syntax in C++`
- `parcel-bundler` (`npm i --save-dev [email protected]`)
- `autoprefixer`
The boilerplate automatically compiles C++ code to WebAssembly and asm.js, the client will dinamically require the first if supported, the second otherwise.
## Prerequisites
- [node](https://nodejs.org)
- [npm](http://npmjs.com/)
- [make](https://www.gnu.org/software/make/)
- [emcc](http://webassembly.org/getting-started/developers-guide/)
- [java](https://www.java.com)
Please make sure to have `emcc` set as an environment variable and the lastest version of `node` to make parcel work. So, to validate the installation, please run the following commands:
```bash
node -v
npm -v
make -v
emcc -v
java -version
```
## Getting started
Clone and install dependencies:
```bash
git clone https://github.com/mbasso/asm-dom-boilerplate.git
cd asm-dom-boilerplate
npm install # or make install
# if you are using windows, you have to make a little change to the Makefile in the root of the project, just open it and follow the instructions at the top
npm start # or make start
```
Then open `http://localhost:1234` to see the example app. You can now edit `index.cpp` and rerun `npm start` to recompile and see the changes.
## Building for Production
```bash
# just run:
make
```
This will compile your C++ and copy your `index.html` to the `dist` folder which you can deploy.
## Makefile
By default the boilerplate preprocess the `.cpp` files in the `src` folder with [gccx](https://github.com/mbasso/gccx) and automatically includes them when compiling. If you want to include external dependencies or add some C flags, you can modify the `Makefile` in the root of the project.
## CSS
[Parcel uses PostCSS plugins to manage CSS assets](https://parceljs.org/transforms.html#postcss).
The boilerplate includes `autoprefixer` for vendor prefixing, you can find and modify the PostCSS setup in `.postcssrc`.
## Authors
**Matteo Basso**
- [github/mbasso](https://github.com/mbasso)
- [@teo_basso](https://twitter.com/teo_basso)
## Copyright and License
Copyright (c) 2018, Matteo Basso.
asm-dom-boilerplate source code is licensed under the [MIT License](https://github.com/mbasso/asm-dom-boilerplate/blob/master/LICENSE.md).