Unmaintained project? I'm upgrading it!

[SirMcPotato]

Hello contributors,

First of all, let me congratulate you for your work on this project! Even if you make proof of modesty by saying it's just a simple wrapper, it remains a great react library that make using OpenLayers with React a real pleasure by its concise syntax!

I'm actually in the need in this exact tool, but can you imagine my face when I tried to add it to my brand new React + Typescript project? Yes, like the pain when you strikes your pinky on a door.
Back to the Github repo, I saw that the last commit was two years ago. Damn, I understand now why it won't work.

But I really want to use it, so I forked it and I'm doing a general upgrade.
Here's my todo-list :

• Upgrade to React 16.x (Implies migrating to the new Context API) (Bump React to 16.x.x #36, Does not work with React Version > 16.0.0 #37)
• Upgrade to OpenLayers 4.6.5 (Yes OpenLayers 5 is out but not Typescript ready yet, and typings are stuck to 4.6.5) (TypeError when using with OpenLayers 4.  #32)
• Ensure proper management of React Components lifecycles.
• Make it absolutely type-safe
• Add missing OpenLayers functionalities
• Complete the missing examples in the available demo app
• Resolve some current reported issues, such as Unnecessary Div makes it difficult to style the map #40, [QUESTION] How to set map size? #41, etc...
• Update @types/ol & @types/openlayers packages from DefinitivelyTyped for missing definition of ol/interaction/extent
• Bonus - Modernise demo app using Material-UI, because I want it to look beautiful ❤️
• Bonus - Update to the latest version of geo-coder, or write a native one
• Bonus - Add tests
• Bonus Upgrade to OpenLayers 5 when typescript ready

Does @allenhwkim or someone else still manage react-openlayers?
I want the original repo staying up to date, so I'll send a PR once I estimate the refactor done, hoping it'll be accepted!
In the case I got no response to the PR, I'm thinking about a complete overhaul once OpenLayers 5 is typescript ready, on a brand new dedicated project, but I hope not!

Thanks for reading!

[allenhwkim]

@SirMcPotato please do. I do keep this repo. open because there are still many users who think this is useful, but not maintaining actively because React/OpenLayers is not my daily job.
As soon as I find you are capable of maintaining it, I will add you as the maintainer.
Please send me your npm user id, so that you can publish it too.

[SirMcPotato]

Hi @allenhwkim, glad you responded, I wasn't sure if you remained active on this repo!
I'm very pleased by your answer, giving me the opportunity to take the hand on it. It is with honor that I accept your proposition.

Actually, I've achieved all the major milestones set for this refactoring.
So I've deployed my fork on npm for testing integration as a 3rd party package into my various React projects in order to ensure that my PR is fully stable and suitable for production. I'm having some import issues, but I'm getting a bit closer each days.

Here's the npm test package link for reference : https://www.npmjs.com/package/@sirmcpotato/react-openlayers
Please note this version is actually a mess, imports are bugged and there's many files that do not belong here. Anyway, this forked package will be deleted once PR accepted and deployed on the main repos, so I don't really care for tidiness at the moment ;)

[SirMcPotato]

Heya, happy new year! 🎉

Here's some updates on the progress of the upgrade.
Actually most of the work is complete. I was working on publication tests and integration as a 3rd party library, but some definitions on @types/openlayers & @types/ol were missing, which is blocking right now.
In order to fix this, I've submited the following PR : DefinitelyTyped/DefinitelyTyped#31708
I'm awaiting for a review and merge of the PR, so I can continue my work on react-openlayers, tidy it up and finally propose a PR for merging!

[Pansarvarg]

Hi @SirMcPotato!

Great to see this project being worked on! Do you have any updates on how work is progressing?

[cdc-dpbrown]

Hello,

I'm in the process of switching from ESRI to this for Epi Info Maps. (https://www.cdc.gov/epiinfo/index.html) Would you recommend me forking from here?

Thank you,
David Brown

[SirMcPotato]

Hi @Pansarvarg!
Actually the port is mostly done, and I'm working on the building toolchain. I had issues using Webpack to produce a working UMD package, which was fixed using Rollup. However, now the examples build is broken and i'm trying to fix this!
On the last weeks, I had to slow down a bit on this project for professional reasons, now things came back to a normal pace I can finish fixing this!

Hello @cdc-dpbrown.
Actually the package I'm working on is not stable, and most of the changes are not yet available online.
I would recommend you to wait a bit for a stable version, that I'll issue in a couple of weeks.
Of course, I'll will let you know here once this is published!

Thanks for your patience.

[cdc-dpbrown]

Hello SirMcPotato,

Thank you. I'll gladly go work on something else and circle back to react-openlayers. Thank you.

David Brown

[meyercm]

@SirMcPotato Are there any tasks that you can carve off for someone else to pick up? Anything you need assistance with? I'd like to help get this to a releasable state, so I can use it with an upcoming project.

[Kampe]

Same, push your current state :)

[dmrobotix]

Any updates? Would love to try this out!

[jonorogers]

@SirMcPotato , any updates? Would also love to help you finish this if you can push where you're at.

[CharanRoot]

@SirMcPotato , any updates. if you need any help. let me know i can help you.

[jwgmeligmeyling]

Im currently using this fork: https://github.com/lobaro/react-openlayers

[wuhland]

@SirMcPotato Any update on this project?

[oehm-smith]

I've worked through a number of forks of this and none seem to work. Bummer! Well I guess its time to check out https://www.npmjs.com/package/react-leaflet and forget openlayers.

Actually https://github.com/AlexJPotter/react-openlayers seems to start (and then show something) without errors.

Mmmm, it runs as webpack-dev-server (ie. npm start) but it doesnt build.

https://github.com/lobaro/react-openlayers is working as reported (however it didn't at first for me - I must have been doing something wacky before).

A PR should be done for this back to the parent project (allenhwkim). Especially given that this project is listed as the React library (https://openlayers.org/3rd-party/).

(Apologies if anyone has been reading this note as it evolved).

[oehm-smith]

What needs to be done to just import it? The example include turns it inside out with the app sitting inside the built code.

Simply copying the entire project in to your app's node_modules seems to work.

cd react-openlayers
npm run build:app

cd ../myapp
cp -r ../react-openlayers ./node_modules

Edit App.js and add

import {Map} from 'react-openlayers'

I'll see how far I get.

Yep, after including the sample code from the README and fixing for missing values, the map appears.

Now we're cooking!

[jwgmeligmeyling]

@oehm-smith Have you tried https://github.com/lobaro/react-openlayers or https://github.com/ealgis/react-openlayers ? I am running that fork in production successfully. It includes a fix of mine that is required to make the module work with minified code.

[oehm-smith]

Yeah thanks @jwgmeligmeyling I discovered it works. On-wards and upwards!

[andrew-linck]

@allenhwkim Are we able to use the package that @SirMcPotato uploaded to npm?

[lobmarib]

@SirMcPotato, did you give up on this? I give it a try on your project and it seems to have the same height issue.