search

webstudio-is / webstudio

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.
https://webstudio.is
GNU Affero General Public License v3.0
4.63k stars 522 forks source link

Webstudio file format (.wstd) for offline export and import #961

Open kof opened 1 year ago

kof commented 1 year ago

As a user I want to be able to import and export the entire project data and assets for several reasons:

  1. I want to debug a cloud project locally
  2. I want to work on it offline
  3. I want to migrate the project between self-hosted setup and webstudio cloud

To provide a full export for webstudio project, we need to export all data along with all assets in some file. Looking at how figma does it, they provide you a *.fig file which is just a zip archive, you can unzip and see inside

We should do the same to have full offline backup and transfer capabilities.

E.g. Figma file

Screenshot 2023-02-07 at 14 12 49

Suggested structure would be something like:

When importing we need to get all that data into the project back

TrySound commented 1 year ago

This should be behind flag as long as possible to avoid issues with migrations.

kof commented 1 year ago

I just created this issue for the future. Supporting the offline format in terms of migrations and API changes is a real pain. Maybe before doing this we need a stable and versioned API or alternatively some different approach. Otherwise this is going to slow us down supporting all possible versions forever.