Skip to content

Commit

Permalink
Improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bruhnild committed Dec 11, 2024
1 parent 6e760d7 commit 07ebcfb
Show file tree
Hide file tree
Showing 6 changed files with 92 additions and 7 deletions.
94 changes: 89 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,94 @@
![https://github.com/Terralego/TerraVisu/actions/workflows/test.yml](https://github.com/submarcos/TerraVisu/actions/workflows/test.yml/badge.svg)![https://codecov.io/gh/submarcos/TerraVisu](https://codecov.io/gh/submarcos/TerraVisu/branch/master/graph/badge.svg)
<h1 align="center">TerraVisu</h1>

<p align="center"><img alt="TerraVisu logo" src="./docs/source/_static/logo_color.png"></p>

![Logo](./docs/source/_static/logo_color.png)
<p align="center">
<a href="https://terravisu.readthedocs.io/en/stable/" rel="nofollow"><img alt="Documentation" src="https://img.shields.io/badge/Documentation-blue.svg" style="max-width:100%;"></a>
<a href="https://demo-terravisu-territoires.makina-corpus.com" rel="nofollow"><img alt="TerraVisu démo" src="https://img.shields.io/badge/Demo-purple.svg" style="max-width:100%;"></a>
</p>
<p align="center">
<a href="https://github.com/Terralego/TerraVisu/releases/latest" rel="nofollow"><img alt="Release" src="https://img.shields.io/github/release/Terralego/TerraVisu.svg" style="max-width:100%;"></a>
<a href="https://github.com/Terralego/TerraVisu/actions/workflows/test.yml" rel="nofollow"><img alt="Unit tests" src="https://github.com/submarcos/TerraVisu/actions/workflows/test.yml/badge.svg" style="max-width:100%;"></a>
<a href="https://codecov.io/gh/submarcos/TerraVisu" rel="nofollow"><img alt="Codecov" src="https://codecov.io/gh/submarcos/TerraVisu/branch/master/graph/badge.svg" style="max-width:100%;"></a>
</p>

![Screenshot](./docs/source/_static/screenshot.png)
<p align="center">
<a href="#website"><b>TerraVisu</b></a> •
<a href="#features"><b>Features</b></a> •
<a href="#user-manual-french"><b>User manual</b></a> •
<a href="#installation-and-configuration"><b>Installation and configuration</b></a> •
</p>
<p align="center">
<a href="#support"><b>Support</b></a> •
<a href="#contribution"><b>Contribution</b></a> •
<a href="#thanks-to-all-contributors-"><b>Contributors</b></a> •
<a href="#license"><b>License</b></a> •
</p>

**Full documentation :** https://terravisu.readthedocs.io/
![TerraVisu demo](./docs/source/_static/screenshot.png)

**Install :** https://github.com/Terralego/TerraVisu/releases/latest/download/install.zip
## TerraVisu

TerraVisu is an interactive web application designed to visualize and analyze spatial data, providing an engaging interface to showcase and explore territorial dynamics and immersive experiences.

You can explore TerraVisu in action through the demonstration website:
- [https://demo-terravisu-territoires.makina-corpus.com](https://demo-terravisu-territoires.makina-corpus.com) :

TerraVisu is built on a modern, modular architecture that leverages React for dynamic interfaces and NextJS for server-side rendering (SSR) and search engine optimization (SEO).

### Examples of TerraVisu portals

- Real-time commercial real estate mapping application: [TerraObs](https://demo-terraobs-territoires.makina-corpus.com/)
- Observe, analyze, and understand territorial dynamics: [Observatoire Maine-et-Loire](https://observatoire.maine-et-loire.fr/)
- An immersive approach where sound and geography blend to offer a new way to travel: [Le Son Unique](https://terravisu-lesonunique.makina-corpus.net/)
- The economic land-use observatory in the PACA region: [Sud Foncier Éco](https://visu.sud-foncier-eco.fr/)

![Portals](./docs/source/_static/portails_terravisu.jpg)

## Features

Explore TerraVisu's powerful features, designed to enhance spatial data visualization, territorial analysis, and immersive experiences through an intuitive and configurable interface:

- **Interactive and dynamic mapping** for real-time spatial data visualization
- **Customizable modules** for specific use cases, such as real estate, territorial analysis, or immersive experiences
- **Responsive web application** with seamless navigation on desktop and mobile devices
- **Advanced search tools** with multi-criteria filtering and data exploration
- **Layer management** for toggling and organizing map data based on zoom levels and themes
- **Detailed dashboards** for data insights and analysis
- **Configuration flexibility** for adapting visuals, themes, and functionality to user needs
- **SEO-friendly architecture** with server-side rendering for better discoverability
- **Documentation** to support both users and administrators

## User manual (french)

- [User guide](https://terravisu.readthedocs.io/en/stable/user_manual/user_guide.html)
- [Admin guide](https://terravisu.readthedocs.io/en/stable/user_manual/admin_user_guide.html)
- [Configuration guide](https://terravisu.readthedocs.io/en/stable/user_manual/module_configuration.html)

## Installation and configuration

- [Installation](https://terravisu.readthedocs.io/en/stable/installation_configuration/install.html)
- [Configuration](https://terravisu.readthedocs.io/en/stable/installation_configuration/configuration.html)

## Support

To report bugs or suggest features, please [submit a ticket](https://github.com/Terralego/TerraVisu/issues).

## Contribution

Interested in contributing? See our [Contributing Guide](https://terravisu.readthedocs.io/en/stable/contribute/contributing.html). You can help in many ways, the ability to code is not necessary.

## Thanks to all contributors ❤

<a href="https://github.com/Terralego/TerraVisu/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Terralego/TerraVisu" />
</a>

Made with [contrib.rocks](https://contrib.rocks).

## License

This project is under the MIT License. See the [LICENSE](https://github.com/Terralego/TerraVisu/blob/master/LICENSE) for details.

<a href="https://territoires.makina-corpus.com/"><img src="https://geotrek.fr/assets/img/logo_makina.svg" alt="Logo MCT" width="115"></a>
[![](https://geotrek.fr/assets/img/logo_autonomens-h120m.png)](https://datatheca.com/)
Binary file modified docs/source/_static/logo_color.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/logo_color_origine.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/portails_terravisu.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@
{
"media": "(prefers-color-scheme: dark)",
"scheme": "slate",
"primary": "red",
"accent": "deep-orange",
"primary": "blue",
"accent": "light-blue",
"toggle": {
"icon": "material/weather-sunny",
"name": "Switch to light mode",
Expand Down
1 change: 1 addition & 0 deletions docs/source/others/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Changelog
**Documentation:**

- Add sphinx_immaterial theme
- Improve README.md


2024.06.0 (2024-06-21)
Expand Down

0 comments on commit 07ebcfb

Please sign in to comment.