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

[FEATURE]: Architectural initiation for CC3 builder #27

Open
1 task done
theonesean opened this issue Nov 14, 2024 · 0 comments
Open
1 task done

[FEATURE]: Architectural initiation for CC3 builder #27

theonesean opened this issue Nov 14, 2024 · 0 comments
Labels
feature New feature or request

Comments

@theonesean
Copy link

theonesean commented Nov 14, 2024

Description

As a CC3 developer, I should be able to build any of the steps of the builder using a standard set of predefined components, utilities, styles, and data model.

Proposed solution

Technologies

Let's stick with vanilla JS (no frameworks) and a single-page architecture to capture user input and choices. Web Components should be leveraged where appropriate (see HL3 builder (https://github.com/EthicalSource/hippocratic-license-3) for inspiration/precedent). Coraline's CSS defaults are already in place in the repository.

Goals

Each step of the builder should take up the entire page and the user should be lead down a simple path with clear UX. Look to products like Typeform for UX inspiration. (See https://www.typeform.com/templates/t/customer-feedback/ for an example.)

There should be shared page-level state for storing user input (mad-libs for enforcement, selection of type of organization that is adopting CC3, any changes to the editable language, etc.).

State should be saved to local storage to allow users to save an in-progress build for later, and to preserve across refreshes. (Also opens us up to future potential to share CC3 builds via serialization. Not currently planned as part of this build.)

Additional context

To come.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@theonesean theonesean added the feature New feature or request label Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant