Implement Welcome Screen - Githubissues

okfn / opendataeditor

The Open Data Editor (ODE) is a no-code application to explore, validate and publish data in a simple way. Forever free and open source project powered by the Frictionless Framework.

http://opendataeditor.okfn.org

MIT License

165 stars 20 forks source link

Implement Welcome Screen #453

Open pdelboca opened 2 months ago

pdelboca commented 2 months ago

New Welcoming screen

Key Features

A new dialog that will pop to the users when they open the application that shows overall information of what ODE is.
A checkbox with an option: Do not show this screen on the next launch
A Get Started button that just closes the dialog
A foot note with a link to the Frictionless framework. (Link to: https://frictionlessdata.io/)
The link to the blog should point to: https://blog.okfn.org/

The new screen should look like

Technical Details

We currently have a config.json file to store project related info. This could be a good place to store the value to not display the screen again.

romicolman commented 2 months ago

Please, check issue #445 before implementing changes. @Faithkenny added additional info in comments.

guergana commented 2 months ago

@pdelboca I thought of storing the value on the store. the one for not displaying the screen again. But the config.json might be a better idea if we can write to it during runtime.

It seems that opening links in an external browser is not as straightforward as it may seem. Is this a common practice?

guergana commented 2 months ago

Hi, @pdelboca I couldn't find the config.json file you are referring to. Could you provide the complete path?

guergana commented 2 months ago

@Faithkenny @pdelboca there is a mismatch with the image here and the detailed figma design. Which is the final design? The one with the blue "Get started" button or the "blue one"? In case it is the gray I would need the figma file with the updated file for the colors and the sizes. :)

Faithkenny commented 2 months ago

@guergana The one with the blue "Get started button" is the final iteration.

guergana commented 2 months ago

I tried two different approaches:

🚫 trying to use the config.json file, which I didn't get to work. Link to the Proof of Concept
✅ persisting data with localstorage using the partialize option from the zustand store and it works like a charm. I think we should use this method to persist all the data across the application because it is very straightforward and is already integrated in the tools we are using in the app. Link to the Zustand approach PR.

guergana commented 2 months ago

@romicolman , we have tested this in Ubuntu 20.04 and in Windows 10 using a virtual machine. Could you please test the Welcome screen in Mac? Also please open the app twice to test that the "Don't show popup on relaunch" is also working as expected.

romicolman commented 1 month ago

Hi! I have just tested the Welcome screen on Mac. Is it possible to adjust the dialog so that the user does not have to scroll? Otherwise, the "Don't show popup on relaunch" won't work (see video attached).

https://github.com/user-attachments/assets/4733c0ea-75a6-414c-af4f-14b664a9c677