Skip to content

Latest commit

 

History

History

README.md

FlatGeobuf for JavaScript / TypeScript

Building

Prerequisites

You must have pnpm installed.

Install FlatGeobuf dependencies

pnpm install

Build

To compile the typescript into a javascript bundle

pnpm build

See the scripts section in package.json for other actions.

Testing the examples locally.

The examples are hard coded to pull in the publicly released artifact. If you'd like to test against your local changes, after running pnpm build, update the <script src= tags in the examples.

For example:

diff --git a/examples/leaflet/filtered.html b/examples/leaflet/filtered.html
index 2e13dfc..da4b07e 100644
--- a/examples/leaflet/filtered.html
+++ b/examples/leaflet/filtered.html
@@ -4,7 +4,7 @@
     <link rel="stylesheet" href="/examples/site.css" />
     <script src="https://unpkg.com/[email protected]/underscore-min.js"></script>
     <script src="https://unpkg.com/[email protected]/dist/leaflet.js"></script>
-    <script src="https://unpkg.com/[email protected]/dist/flatgeobuf-geojson.min.js"></script>
+    <script src="/dist/flatgeobuf-geojson.min.js"></script>
     <script src="https://unpkg.com/[email protected]/dist/json-formatter.umd.js"></script>

You can start the built in http server with: pnpm serve.

Then, open the example in your browser. For example: open http://localhost:8000/examples/leaflet/filtered.html.