Documentation for use with React

stadiamaps / ferrostar

A FOSS navigation SDK built from the ground up for the future

https://stadiamaps.github.io/ferrostar/

Other

179 stars 24 forks source link

Documentation for use with React #212

Open ianthetechie opened 2 months ago

ianthetechie commented 2 months ago

The web component currently explains Vue integration but not React.

AdarshSahani003 commented 1 week ago

Hi @ianthetechie ,

I have drafted some documentation for integrating the Ferrostar Navigation SDK with React using Vite. I believe this will complement the existing Vue integration documentation.

react-integration-docs.md

Here’s a brief overview of what I’ve included:

Installation instructions for Ferrostar in a React project.
A sample NavigationComponent demonstrating how to initialize Ferrostar and use geolocation.
Guidelines for managing state and events in a React application.

I would appreciate any feedback or suggestions before I proceed with creating a pull request. If you think this addition is valuable, I will finalize it and submit my changes.

Thank you!

Best, AdarshSahani003

ianthetechie commented 1 week ago

Thanks @AdarshSahani003! Yes, a PR would be most welcome :) Looks like this is going the right direction (though I'm not sure why all the backticks are escaped). Feel free to just open a PR and we can carry an the edit discussion there more easily :)

I think we can probably fit both Vue and React in the same document (https://github.com/stadiamaps/ferrostar/blob/main/guide/src/web-getting-started.md), since most of the code is actually the same. It's just a few details around project setup.

No need to make any changes to the demo app itself btw. We don't have the bandwidth to maintain multiple at the moment so we'll just stick with Vue, but having these setup bits for React would be great!

AdarshSahani003 commented 1 week ago

Thanks @ianthetechie for the feedback! I'll prepare the pull request with the documentation, and we can continue the discussion there. I'll also make sure to adjust any escaped backticks and align with the idea of combining both Vue and React setups.