Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating web example #2

Merged
merged 8 commits into from
Sep 9, 2021
Merged

Updating web example #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1817f3d
update stdlib
phated Aug 30, 2021
6e6f109
update gitignore
phated Aug 30, 2021
f89cd07
update runner
phated Aug 30, 2021
0022b76
update comment syntax
phated Aug 30, 2021
894b7c5
update js loading
phated Aug 30, 2021
1130546
filename change
phated Aug 30, 2021
ac8d722
Grain 0.4 and npm packages
phated Sep 8, 2021
3fad0ba
update docs
phated Sep 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
node_modules
**/*.gr.wasm
stdlib/*.md
26 changes: 18 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,40 @@ This repo contains an example of Grain wasm files running in a browser.

## Setup

You'll first need to compile the wasm files. The easiest way to do this is to use the Grain cli:
First, you'll need to install the Grain compiler by following the [Getting Grain](https://grain-lang.org/docs/getting_grain) guide for your operating system.

Additionally, you'll need to install the project dependencies using:

```sh
npm install
```

The easiest way to compile your Grain files to WebAssembly is to use the built-in npm script:

```sh
grain hello.gr --stdlib=./stdlib
npm run compile
```

This will compile `hello.gr`, `another.gr`, and the necessary stdlib dependencies. Note that I copied Grain's standard library into this project—in the future, the standard library will be available as a consumable package from npm.
This will compile `hello.gr`, `another.gr`, and the necessary stdlib dependencies.

Run a webserver in this directory. If you have Python 3 on your computer, you can run
Then, run a webserver in this directory. You can use our other npm script:

```sh
python -m http.server
npm start
```

If you visit `localhost:8000` and open your dev console, you should see the hello world messages appear.
(This script will also compile your project before starting the webserver).

If you visit `localhost:1337` and open your dev console, you should see the hello world messages appear.

## `index.html` Breakdown

We first load the Grain browser runtime with this script tag:

```html
<script src="js/grain-runtime-browser.js"></script>
<script src="node_modules/@grain/js-runner/dist/grain-runner-browser.js"></script>
```

`Grain.buildGrainRunner` takes a locator function as its argument. In this case, we just use the `defaultURLLocator`. As arguments, we pass the locations to look for wasm files—the current URL as the root, and the `stdlib` subdirectory. The default locator will try to find wasm files by first looking in the root of this project, followed by the stdlib directory.
`Grain.buildGrainRunner` takes a locator function as its argument. In this case, we just use the `defaultURLLocator`. As arguments, we pass the locations to look for wasm files—the current URL as the root, and the `node_modules/@grain/stdlib` subdirectory. The default locator will try to find wasm files by first looking in the root of this project, followed by the stdlib directory.

Once the `GrainRunner` is set up, we call `GrainRunner.runURL` with `hello.wasm`. The locator will then fetch `hello.wasm`, see that it depends on `another.wasm` and `pervasives.wasm`, and load those as well.
Binary file added favicon.ico
View file
Open in desktop
Binary file not shown.
4 changes: 2 additions & 2 deletions hello.gr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {anotherHello} from './another'
import { anotherHello } from "./another"

print('Hello, world!')
print("Hello, world!")
print(anotherHello)
6 changes: 3 additions & 3 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<html>
<head>
<script src="js/grain-runtime-browser.js"></script>
<script src="node_modules/@grain/js-runner/dist/grain-runner-browser.js"></script>
<script>
let locator = Grain.defaultURLLocator(['/', '/stdlib']);
let locator = Grain.defaultURLLocator(['/', 'node_modules/@grain/stdlib']);
let GrainRunner = Grain.buildGrainRunner(locator);
GrainRunner.runURL('hello.wasm');
GrainRunner.runURL('hello.gr.wasm');
</script>
</head>
</html>
Loading