hicommonwealth / commonwealth

A platform for decentralized communities
https://commonwealth.im
GNU General Public License v3.0
67 stars 44 forks source link

Flarum Import Spike Research #4352

Open ianrowan opened 1 year ago

ianrowan commented 1 year ago

Research Flarum Import possibilities with Discourse import scripts as a reference

ianrowan commented 1 year ago

Given the approach we used for the Discourse Import the first requirement to use a similar approach is a database dump from Flarum.

Given their docs: https://docs.flarum.org/ I have not identified if this is possible yet. What they do have is a REST API. The docs do not however provide good clarity on how it works beyond providing a /discussion endpoint(no params specified) that will provide all 'discussions' which are assumed to be similar to our Threads.

The only approach thats clear at this time would be to parse through API calls to get discussions.

Given the that they mentioned they would be willing to do that work I think the most logical first step would be to give them a list of requirements to help facilitate the import and allow them to attempt to accommodate the data requirements we have on the discourse script. Requirement include

  1. An SQL dump of their Flarum data(usually only exportable by admins and uncertain if flarum provides this, but they could find out easier than us)
  2. A mapping of what they want to import given our Schema(ie Discussions -> Threads)

Provided with these details which should be much easier for them to confirm/deny we could most effectively adjust our discourse approach to import their data

CC: @MuonShot