Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add link for interactive xlsform editing during project creation #1480

Merged
merged 5 commits into from
May 21, 2024

Conversation

spwoodcock
Copy link
Member

@spwoodcock spwoodcock commented Apr 26, 2024

What type of PR is this? (check all applicable)

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation
  • πŸ§‘β€πŸ’» Refactor
  • βœ… Test
  • πŸ€– Build or CI
  • ❓ Other (please specify)

Describe this PR

Do not merge this code, as I first need to be granted a license for using the Excel/spreadsheet web component (it is normally commercial, but they can provide an NGO license, tbc).

  • Updated logic for XLSForm loading at backend startup. Removes old forms that no longer exist.
  • Currently only the buildings form is available, after the Entity update.
  • Added a comment that users should extend an existing XLSForm if they want to provide a custom form.
  • Added a link during project creation to download the template form.
  • Also added a link to an interactive XLSX editor, with the form preloaded (essentially Excel in the browser!).

Screenshots

image

image

Alternative Approaches Considered

  • I did a lot of research and dug into the XForm editing functionality of KoboToolbox.
  • It's quite a convoluted mess, using CoffeeScript - I struggled to even load the code.
  • At some point we could get inspiration from this and have a fully embedded XForm editor in FMTM.

This is the Kobo implementation - a little outdated, but still pretty nice:
image

Review Guide

Checklist before requesting a review

[optional] What gif best describes this PR or how it makes you feel?

giphy

@spwoodcock spwoodcock requested a review from NSUWAL123 April 26, 2024 00:14
@spwoodcock spwoodcock self-assigned this Apr 26, 2024
@github-actions github-actions bot added frontend Related to frontend code backend Related to backend code migration Contains a DB migration labels Apr 26, 2024
@spwoodcock
Copy link
Member Author

Still waiting on a reply for the licensing, but the license states this:

"
This is a commercial product, requiring a valid paid-for license for commercial use.
This product is free to use for non-commercial educational use for students in K through 12 grades
or University programs, and for educators to use in a classroom setting as examples / tools in their curriculum.
"

I'm assuming we should be eligible for non-commercial NGO usage.

Merging until I hear otherwise!

@spwoodcock spwoodcock merged commit 340d04e into development May 21, 2024
7 checks passed
@spwoodcock spwoodcock deleted the feat/interactive-xlsform-edit branch May 21, 2024 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Related to backend code frontend Related to frontend code migration Contains a DB migration
Projects
Development

Successfully merging this pull request may close these issues.

2 participants