https://github.com/terrestris/react-geo

A set of geo related modules to use in combination with React, Ant Design and OpenLayers.
https://github.com/terrestris/react-geo

ant-design geo hacktoberfest openlayers react typescript

Last synced: about 8 hours ago
JSON representation

A set of geo related modules to use in combination with React, Ant Design and OpenLayers.

• Host: GitHub
• URL: https://github.com/terrestris/react-geo
• Owner: terrestris
• License: bsd-2-clause
• Created: 2017-08-31T08:18:26.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-11-29T08:03:26.000Z (14 days ago)
• Last Synced: 2024-12-01T09:09:25.623Z (12 days ago)
• Topics: ant-design, geo, hacktoberfest, openlayers, react, typescript
• Language: TypeScript
• Homepage: https://terrestris.github.io/react-geo/
• Size: 473 MB
• Stars: 370
• Watchers: 19
• Forks: 58
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-react-cn - react-geo - A set of geo-related components using react, antd, and ol (Uncategorized / Uncategorized)
• awesome-react - react-geo - A set of geo-related components using react, antd, and ol
• awesome-learning-resources - react-geo - A set of geo-related components using react, antd, and ol (Uncategorized / Uncategorized)
• awesome-react - react-geo - A set of geo related modules to use in combination with React, Ant Design and OpenLayers. ` 📝 4 days ago` (React [🔝](#readme))

README

        
# react-geo  

[![npm version](https://img.shields.io/npm/v/@terrestris/react-geo.svg?style=flat-square)](https://www.npmjs.com/package/@terrestris/react-geo)

[![GitHub license](https://img.shields.io/github/license/terrestris/react-geo?style=flat-square)](https://github.com/terrestris/react-geo/blob/main/LICENSE)

[![Coverage Status](https://img.shields.io/coveralls/github/terrestris/react-geo?style=flat-square)](https://coveralls.io/github/terrestris/react-geo?branch=main)

![GitHub action build](https://img.shields.io/github/actions/workflow/status/terrestris/react-geo/on-push-main.yml?branch=main&style=flat-square)

[![Known Vulnerabilities](https://snyk.io/test/github/terrestris/react-geo/badge.svg)](https://snyk.io/test/github/terrestris/react-geo)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/terrestris/react-geo/blob/main/CONTRIBUTING.md)

`react-geo` is a JavaScript library providing a large number of components to build modern mapping applications. It is used in combination with [React](https://github.com/facebook/react), [OpenLayers](https://github.com/openlayers/openlayers) and [Ant Design](https://github.com/ant-design/ant-design).

## Installation

```javascript static

npm i --save @terrestris/react-geo

```

## Usage

For a full list of available components, their properties and examples see [here](https://terrestris.github.io/react-geo/docs/latest/index.html).

### TypeScript

The `react-geo` package includes TypeScript declarations as `*.d.ts` files. The build itself is included in ESM format (currently ES2022).

### Styling

`react-geo` supports dynamic theming [via CSS variables](https://4x.ant.design/docs/react/customize-theme-variable) and requires the following import inside your project.

```css

@import '~antd/dist/antd.variable.min.css';

```

## Workshop

For a comprehensive introduction into the usage of `react-geo` you might want to have a look at our [tutorial](https://terrestris.github.io/react-geo-ws/).

## Starter application

Also don't miss the [create-react-geo-app (CRGA)](https://github.com/terrestris/create-react-geo-app) to quickly create a fully working

web-mapping application based on `react-geo`.

## Contribution

Contributions are much appreciated! 🥳

Read the [hints for developers](https://github.com/terrestris/react-geo/blob/main/CONTRIBUTING.md) to get started. We look forward to your contributions!

## License

`react-geo` is released under the BSD 2-Clause license. Please see the file [LICENSE](https://github.com/terrestris/react-geo/blob/main/LICENSE) in the root of this repository for more details.