Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 3.23.2 #1302

Merged
merged 80 commits into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
80 commits
Select commit Hold shift + click to select a range
74898ec
Clear debounce during cleanup useEffect
dtrucs Oct 10, 2024
e78e805
Do not empty dom when loading and transitionning page
dtrucs Oct 9, 2024
476edab
Improve Loader component
dtrucs Oct 15, 2024
257fefd
Optimize Backpack icon
dtrucs Oct 17, 2024
7bbc789
Improve DetailsGear component
dtrucs Oct 17, 2024
c128747
Fix snapshot related to detailsGear
dtrucs Oct 17, 2024
e83a4b2
Create DetailsDates component
dtrucs Oct 18, 2024
70faeca
Adapt TouristicEvent module to display dates correctly
dtrucs Oct 18, 2024
809da28
Defining dateFormat variables for greater readability
dtrucs Oct 18, 2024
fa59e2f
Apply suggestions from code review
dtrucs Oct 18, 2024
6f84bda
Use encodeURIComponent instead of encodeURI to build URI
dtrucs Oct 24, 2024
6f7ff9d
Fix map zoomControl displayed on mobile viewport
dtrucs Oct 21, 2024
fa8b3c9
Build "Show More" menu items only if there are enough
dtrucs Oct 29, 2024
3ca386e
Fix infiniteScroll
dtrucs Oct 28, 2024
6f75bb3
Remove useless path prop
dtrucs Oct 29, 2024
69b1e02
Improve styling spacing HDviewpoint annotation
dtrucs Oct 31, 2024
82d4f16
Fix touristicContents links for activityBar
dtrucs Nov 4, 2024
ab7cd78
Bump package.json / 3.23.2
dtrucs Nov 12, 2024
20daa9b
Create mkdocs.yml
camillemonchicourt Sep 17, 2024
661d726
Create .readthedocs.yaml
camillemonchicourt Sep 17, 2024
0917bb8
Move mkdocs.yml to docs/mkdocs.yml
camillemonchicourt Sep 17, 2024
df62495
Update .readthedocs.yaml
camillemonchicourt Sep 17, 2024
2e3ca95
Update mkdocs.yml
camillemonchicourt Sep 17, 2024
4b02c45
Move docs/mkdocs.yml to mkdocs.yml
camillemonchicourt Sep 17, 2024
326515e
Move docs/.readthedocs.yaml to .readthedocs.yaml
camillemonchicourt Sep 17, 2024
62f5de6
Update mkdocs.yml
camillemonchicourt Sep 17, 2024
1e23e37
Create index.md
camillemonchicourt Sep 17, 2024
73de083
Update mkdocs.yml
camillemonchicourt Sep 17, 2024
cec6cc0
Move to readthedocs theme
camillemonchicourt Sep 17, 2024
e491575
Update mkdocs.yml
camillemonchicourt Sep 17, 2024
c51d042
Update .readthedocs.yaml
camillemonchicourt Sep 17, 2024
c3bc395
Move mkdocs.yml to docs/mkdocs.yml
camillemonchicourt Sep 17, 2024
4bbedc8
Update mkdocs.yml
camillemonchicourt Sep 17, 2024
74b1c1b
Update .readthedocs.yaml
camillemonchicourt Sep 17, 2024
7ef8107
Rename docs/mkdocs.yml to mkdocs.yml
camillemonchicourt Sep 17, 2024
d154490
Update installation.md header sizes
camillemonchicourt Sep 17, 2024
a2ee8cb
Update customization.md
camillemonchicourt Sep 17, 2024
b6f7d9c
Update customization-scripts-GDPR.md
camillemonchicourt Sep 17, 2024
bbca233
Update customization.md
camillemonchicourt Sep 17, 2024
2160789
Update customization.md
camillemonchicourt Sep 17, 2024
47519fa
Update server-side-rendering.md
camillemonchicourt Sep 17, 2024
3115d65
Update mkdocs.yml
camillemonchicourt Sep 17, 2024
57a5c3a
Update mkdocs.yml
camillemonchicourt Sep 17, 2024
8be2d43
Update mkdocs.yml
camillemonchicourt Sep 17, 2024
5216ab8
Update index.md
camillemonchicourt Sep 17, 2024
24a3a19
Update mkdocs.yml
camillemonchicourt Sep 17, 2024
01a754a
Update development.md
camillemonchicourt Sep 17, 2024
27c958e
Update development.md
camillemonchicourt Sep 17, 2024
85ba3ef
Update mkdocs.yml
camillemonchicourt Sep 17, 2024
8c41deb
Add logo, favicon and homepage in doc
bruhnild Sep 27, 2024
6c599f2
Update index homepage and summary navbar
bruhnild Sep 30, 2024
e060602
Add infos about contributing doc
bruhnild Sep 30, 2024
3db3638
Fix indent and links
bruhnild Sep 30, 2024
8a212b6
Review development.md
camillemonchicourt Sep 30, 2024
5ea348b
Remove logos from index.md
camillemonchicourt Sep 30, 2024
e543aa9
Add material for mkdocs
bruhnild Oct 2, 2024
feb21c5
fix ci error remove emoji extension
bruhnild Oct 2, 2024
92e4642
Add requirements
bruhnild Oct 2, 2024
4735ec2
Improve toc and knowledge and architecture section
bruhnild Oct 2, 2024
f9b50ed
reindent code blocs
bruhnild Oct 2, 2024
363bb2d
Add context to deployment_solution.md and main_framework.md
bruhnild Oct 2, 2024
09a657d
Fix titles
bruhnild Oct 2, 2024
ff09b9b
Include issue's comments in doc for custo and add a contributing section
bruhnild Oct 2, 2024
f121eae
Add contributing doc
bruhnild Oct 2, 2024
a05bf0d
Split customization doc
bruhnild Oct 4, 2024
6fcb7da
Remove rando v3 mention
dtrucs Oct 14, 2024
7999906
Update README
bruhnild Oct 11, 2024
c2ba068
Improve contributing page
bruhnild Oct 17, 2024
cc0c557
Improve documentation and dev setup pages
bruhnild Oct 17, 2024
fafd5e9
Add extension to manage issues links in changelog
bruhnild Oct 17, 2024
9de3974
Improve contributing documentation
dtrucs Oct 17, 2024
7551dc7
Update contributing issue report
dtrucs Oct 17, 2024
276335b
Update readme.md and contributing.md
bruhnild Oct 17, 2024
4f9b2ea
Add suggestion for improving contributing.md
bruhnild Oct 17, 2024
768f80c
Update index.md, readme.md and fix gdpr title page
bruhnild Oct 31, 2024
12b70f3
Fix links in readme.md
bruhnild Oct 31, 2024
207a484
Add portals examples in readme and fix titles in doc
bruhnild Oct 31, 2024
8265508
Fix demo link
bruhnild Oct 31, 2024
073f4a6
Update shields in readme
bruhnild Oct 31, 2024
9ac4399
Add entry to the changelog
dtrucs Nov 12, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Read the Docs configuration file for MkDocs projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"

python:
install:
- requirements: ./mkdocs/requirements.txt

mkdocs:
configuration: ./mkdocs/mkdocs.yml
113 changes: 96 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,114 @@
# Geotrek-rando V3
<h1 align="center">Geotrek-rando</h1>

![Search](https://geotrek.ecrins-parcnational.fr/images/gtr3-04-search.jpg)
<p align="center"><img alt="geotrek rando image" src="/docs/img/geotrek-rando.png"></p>

<p align="center">
<a href="https://geotrek-rando-v3.readthedocs.io/" rel="nofollow"><img alt="Documentation" src="https://img.shields.io/badge/Documentation-green.svg" style="max-width:100%;"></a>
<a href="https://gtr3demo.ecrins-parcnational.fr/" rel="nofollow"><img alt="Geotrek Rando demo by Ecrins National Park" src="https://img.shields.io/badge/Demo-PN Ecrins-orange.svg" style="max-width:100%;"></a>
<a href="https://demo-rando.geotrek.fr/" rel="nofollow"><img alt="Geotrek Rando demo" src="https://img.shields.io/badge/Demo-purple.svg" style="max-width:100%;"></a>
<a href="https://matrix.to/#/%23geotrek:matrix.org" rel="nofollow"><img alt="Chat Matrix" src="https://img.shields.io/badge/Chat-blue.svg" style="max-width:100%;"></a>
<a href="https://groups.google.com/g/geotrek-fr" rel="nofollow"><img alt="Forum Google Group" src="https://img.shields.io/badge/Forum-brightgreen.svg" style="max-width:100%;"></a>
</p>
<p align="center">
<a href="https://github.com/GeotrekCE/Geotrek-rando-v3/releases/latest" rel="nofollow"><img alt="Release" src="https://img.shields.io/github/release/GeotrekCE/Geotrek-rando-v3.svg" style="max-width:100%;"></a>
<a href="https://github.com/GeotrekCE/Geotrek-rando-v3/actions/workflows/e2e.yml" rel="nofollow"><img alt="Status Test E2E" src="https://github.com/geotrekce/Geotrek-rando-v3/actions/workflows/e2e.yml/badge.svg" style="max-width:100%;"></a>
<a href="https://github.com/GeotrekCE/Geotrek-rando-v3/actions/workflows/e2e.yml" rel="nofollow"><img alt="Status Test E2E" src="https://github.com/geotrekce/Geotrek-rando-v3/actions/workflows/action-intall-and-test.yml/badge.svg" style="max-width:100%;"></a>
<a href="https://github.com/GeotrekCE/Geotrek-rando-v3/actions/workflows/e2e.yml" rel="nofollow"><img alt="Status Test E2E" src="https://github.com/geotrekce/Geotrek-rando-v3/actions/workflows/release.yml/badge.svg" style="max-width:100%;"></a>
</p>

<p align="center">
<a href="#website"><b>Website</b></a> •
<a href="#features"><b>Features</b></a> •
<a href="#admin-documentation"><b>Admin documentation</b></a> •
<a href="#developer-documentation"><b>Developer documentation</b></a> •
</p>
<p align="center">
<a href="#architecture-decision-record"><b>Architecture decision record </b></a> •
<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>

![Search](/docs/img/home_ecrins.png)

## Website

Geotrek-rando is the public web application displaying the interface you can use to value your territory treks and tourism products!
Demo available at https://gtr3demo.ecrins-parcnational.fr.
You can find two demonstration websites at the following links:
- [https://gtr3demo.ecrins-parcnational.fr](https://gtr3demo.ecrins-parcnational.fr)
- [https://demo-rando.geotrek.fr/](https://demo-rando.geotrek.fr)

The third version is a full redesign and rewriting of Geotrek-rando with React, and NextJS for Server side rendering (SSR) and SEO.

Geotrek-rando v3 is directly connected to Geotrek-admin v2 API.
Geotrek-rando is directly connected to Geotrek-admin v2 API.

Read more in the [general presentation (french)](https://geotrek-rando-v3.readthedocs.io/latest/presentation-fr/).

### Examples of Geotrek-rando portals

- Promoting outdoor activities: [Escapade62](https://www.escapade62.fr/)
- Exploring the Écrins National Park: [Destination Écrins](https://destination.ecrins-parcnational.fr/)
- Discover Mediterranean treks, throught land and sea: [Destination Port-Cros](https://destination.portcros-parcnational.fr/)
- Walks and hikes in the PACA region: [Chemins des Parcs](https://www.cheminsdesparcs.fr/)

![Search](/docs/img/portails.jpg)

Discover more users close to your place by going onto the [user map](https://geotrek.fr/utilisateurs.html).

For a full list of known rando-based applications, visit the [Geotrek applications list](https://github.com/GeotrekCE/Geotrek-website/wiki/Liste-des-Geotrek-connus).

Read more in the [general presentation](./docs/presentation-fr.md).
## Features

## Documentation for administrators
Discover Geotrek-Rando's top features, designed to elevate outdoor exploration with dynamic maps, detailed treks info, and offline accessibility—all in a customizable, mobile-friendly interface :

- [Installation for production](./docs/installation.md)
- [Customization](./docs/customization.md)
- **Responsive PWA** interface with offline access
- **Customizable** homepage
- **Advanced search** with filters and **interactive map**
- **Detailed information** on each trek, outdoor activities, touristic services and events
- **Download options** (PDF, GPX, KML)
- **Static pages** for general info
- **Interactive mapping** with elevation profiles
- **API integration** with Geotrek-Admin for real-time data
- **Design and content customization** (theme, colors, maps)
- **SEO optimization** with server-side rendering.

## Documentation for developers
## Admin documentation

- [Installation on a dev machine](./docs/development.md)
- [Deployment](./docs/deployment.md)
- [Production setup](https://geotrek-rando-v3.readthedocs.io/latest/installation/)
- [Customization](https://geotrek-rando-v3.readthedocs.io/latest/customization/customization-introduction/)

## Getting started
## Developer documentation

- Follow the [development](./docs/development.md) docs
- Head to [localhost:3000](http://localhost:3000)
- [Development setup](https://geotrek-rando-v3.readthedocs.io/latest/development/installation/)
- [Deployment](https://geotrek-rando-v3.readthedocs.io/latest/development/deployment/)

## Architecture decision records
## Architecture decision record

- [Main framework](./docs/adrs/main_framework.md)
- [Deployment solution](./docs/adrs/deployment_solution.md)
- [Main framework](https://geotrek-rando-v3.readthedocs.io/latest/adrs/main_framework/)
- [Deployment solution](https://geotrek-rando-v3.readthedocs.io/latest/adrs/deployment_solution/)

## Support

- To report bugs or suggest features, please [submit a ticket](https://github.com/GeotrekCE/Geotrek-rando-v3/issues).
- Join our community to stay updated and share your experience! Connect on [Matrix](https://matrix.to/#/%23geotrek:matrix.org) for real-time discussions, or connect through the [Google Group](https://groups.google.com/g/geotrek-fr) to exchange ideas and insights.

## Contribution

Interested in contributing? See our [Contributing Guide](https://geotrek-rando-v3.readthedocs.io/latest/development/contributing/). You can help in many ways, the ability to code is not necessary.

## Thanks to all contributors ❤

<a href="https://github.com/GeotrekCE/Geotrek-rando-v3/graphs/contributors">
<img src="https://contrib.rocks/image?repo=GeotrekCE/Geotrek-rando-v3" />
</a>

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

## License

This project is under the MIT License. See the [LICENSE](https://github.com/GeotrekCE/Geotrek-rando-v3/blob/main/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/)

3 changes: 2 additions & 1 deletion docs/adrs/deployment_solution.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

## Context and Problem Statement

We need to have an easy way to deploy this server for it to be runnable on the most various environments.
This analysis has been done in 2020, when we started redesigning Geotrek-rando globally, to choose the right technology.
We needed to have an easy way to deploy this server for it to be runnable on the most various environments.

## Decision Drivers sorted by priority

Expand Down
3 changes: 2 additions & 1 deletion docs/adrs/main_framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

## Context and Problem Statement

In order to produce a scalable, performant and efficient front, we need to choose the right framework head start.
This analysis has been done in 2020, when we started redesigning Geotrek-rando globally, to choose the right technology.
In order to produce a scalable, performant and efficient front, we needed to choose the right framework head start.

## Decision Drivers sorted by priority

Expand Down
22 changes: 21 additions & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# Changelog

## 3.23.2 (2024-11-12)

**📝 Documentation**

- Redesign of the documentation (#1254) - New documentation website available at https://geotrek-rando-v3.readthedocs.io

**✨ Improvements**

- Optimize backpack icon (#1287)
- Adapt touristic event module to display dates correctly (#1288)
- Improve styling spacing HDviewpoint annotation (#1298)

**🐛 Fixes**

- Fix of URI encoding for paths containing specific characters (#1205 and #1077)
- Fix map zoomControl displayed on mobile viewport (#1290)
- Clear debounces during cleanup useEffect (#1283)
- Build "Show More" menu items only if there are enough (#1296)
- Fix touristicContents links for activityBar - regression since 3.22.0 (#1299)

## 3.23.1 (2024-10-14)

**🔧 Maintenance**
Expand Down Expand Up @@ -1141,4 +1161,4 @@ If you update Geotrek-rando v3, the global Docker process has been updated to av
1.x and 2.x
-----------

See the repository dedicated to versions 1 and 2 of Geotrek-rando: https://github.com/GeotrekCE/Geotrek-rando
See the repository dedicated to versions 1 and 2 of Geotrek-rando: https://github.com/GeotrekCE/Geotrek-rando
Loading
Loading