Skip to main content

Installation

This guide will help you install flywave.gl and its related dependencies.

System Requirements​

  • Node.js: >=22.15.0
  • pnpm: >=9.0.0 (recommended) or npm

Installation Methods​

pnpm add @flywave/flywave.gl

Using npm​

npm install @flywave/flywave.gl

Usage in Browser​

To use flywave.gl in a browser environment, include the library in your HTML:

<!DOCTYPE html>
<html>
<head>
    <title>Flywave.gl Example</title>
</head>
<body>
    <canvas id="mapCanvas"></canvas>
    <script src="node_modules/@flywave/flywave.gl/dist/flywave.gl.min.js"></script>
    <script>
        const mapView = new flywave.MapView({
            canvas: document.getElementById('mapCanvas')
        });
    </script>
</body>
</html>

Module Import​

For modern JavaScript/TypeScript projects, you can import modules directly:

import { MapView } from '@flywave/flywave.gl';

const mapView = new MapView({
    canvas: document.getElementById('mapCanvas')
});

Verification​

To verify that the installation was successful:

# Check installed version
npm list @flywave/flywave.gl

Troubleshooting​

If you encounter any issues during installation:

  1. Make sure your Node.js version meets the requirements
  2. Clear npm/pnpm cache: 
    npm cache clean --force
    # or
    pnpm store prune
  3. Delete node_modules and reinstall: 
    rm -rf node_modules
    pnpm install

For more detailed troubleshooting, please refer to our documentation or community support.