Website · Documentation · Issues

---

💡 We are hiring full-time OSS comitters! https://eukarya.io/join

Features

Visualizer is a powerful tool for visualizing GIS data, offering a range of features to enhance your mapping experience:

• Comprehensive WebGIS Support: Visualizer supports various common WebGIS data types, displaying them seamlessly on a digital map using Cesium as the rendering engine.
• Interactive Geometry Drawing: Draw geometric shapes directly on the map for custom annotations and spatial analysis.
• Conditional Layer Styling: Modify display styles for individual layers based on conditions, allowing for personalized data visualization.
• Engaging Storytelling Feature: Create interactive, page-by-page narratives with your GIS data using the built-in storytelling feature.
• Customizable Interface with Plugins: Use the plugin system to create custom solutions and tailor the interface of public projects to suit your needs.
• Easy Project Publishing and Sharing: Publish your projects and share them effortlessly through distribution, embedding, or custom URLs.
• Community Plugin Marketplace: Add your custom plugins to the marketplace and allow other users to integrate them into their projects.

Built with

React, TypeScript, Go, GraphQL, MongoDB, WebAssembly (plugin execution), OpenID Connect

Getting Started

Start Backend Services

Before you begin, please ensure that Docker is properly installed and running on your machine.

Windows users: Please use WSL (Windows Subsystem for Linux) for development. All commands below work within WSL.

1. Clone the repository:

   git clone https://github.com/reearth/reearth-visualizer.git
   cd reearth-visualizer/server

2. Start the backend server. This command will automatically start the database, mock GCS storage, and create .env files if they don't exist:

   make d-run

3. Initialize the development environment. This creates a mock user and sets up the mock GCS bucket. This step is only required for the first-time setup:

   make setup-dev

For more details on backend development commands, see server/README.md.

---

Start Frontend Service

1. Navigate to the web directory of your visualizer project and create a local .env file:

   cd web
   touch .env

2. Add the following environment variables to your .env file:

   # .env
   REEARTH_WEB_API=http://localhost:8080/api
   REEARTH_WEB_PLUGINS=http://localhost:8080/plugins
   REEARTH_WEB_CESIUM_ION_ACCESS_TOKEN=your_cesium_ion_access_token_here
   REEARTH_WEB_AUTH_PROVIDER=mock
   

   To obtain a Cesium Ion Access Token, please follow this official guide.

3. Install dependencies and start the frontend server:

   yarn && yarn start

---

✅ Done!

You should now be able to access the Re:Earth Visualizer locally at:
👉 http://localhost:3000

---

🌎 Environment

Supported OS

Windows 10+	macOS 10.12+ (Sierra)	ChromeOS	iOS 11+	Android 10+	Linux (Desktop)
✅	✅	✅	✅	✅	✅

---

For more information, please refer to the Documentation.

Web Browsers

Edge	Firefox	Chrome	Safari	iOS Safari	Chrome for Android
91+	57+	58+	11+	last 2 versions	last 2 versions

Contributing

See the contributing guide.

Contributers

Made with contrib.rocks.

Contact

Re:Earth core committers: [email protected]

License

Distributed under the Apache-2.0 License. See LICENSE for more information.