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

Demo setup/generators supporting different setup scenarios #1893

Open
2 tasks
sleidig opened this issue Jun 5, 2023 · 1 comment · May be fixed by #2709
Open
2 tasks

Demo setup/generators supporting different setup scenarios #1893

sleidig opened this issue Jun 5, 2023 · 1 comment · May be fixed by #2709
Labels
Status: Community Help Wanted (good first issue) simple tasks that don't require understanding every last detail of our platform

Comments

@sleidig
Copy link
Member

sleidig commented Jun 5, 2023

In practice, we are running multiple demo sites for different use cases (e.g. education, health, vocational training). However, the code only supports a single demo setup (config-fix.ts) and the demo data generator services have hard-coded parameters on what to generate. As a workaround, other demo systems are actually run in "synced" mode and cannot auto-generate new data every time a user visits the site.

Requirements / Suggested implementation:

  • allow to put a file into assets folder demo_entities.json that contains docs to be saved into the database in demo mode (after the demo generators ran?)
  • (advanced, maybe later) configure some parameters for the demo data generators through the config (so that demo notes can talk about health instead of school topics in another scenario, for example)

Sample demo_entities.json:

{
"docs": [
    {
      "_id": "Config:CONFIG_ENTITY",
      "otherField": "xyz"
    },
    { /* other doc to be saved using `_bulk_docs` */ }
]
}
@sleidig sleidig added the Status: Idea to be considered and discussed - don't start work yet label Jun 5, 2023
@sleidig
Copy link
Member Author

sleidig commented Feb 12, 2024

This is actually a more important problem now, because keycloak login (which is required now) doesn't allow to use the app in an iframe (which we are doing to display the username + password to website visitors).

Current demos are:

@sleidig sleidig added Type: Bug Status: Community Help Wanted (good first issue) simple tasks that don't require understanding every last detail of our platform and removed Status: Idea to be considered and discussed - don't start work yet labels Feb 12, 2024
@sleidig sleidig moved this from Triage / Analysis to Todo (ready for work) in All Tasks & Issues Feb 12, 2024
@sleidig sleidig removed the Type: Bug label Feb 13, 2024
@sleidig sleidig moved this from Todo (ready for work) to Triage / Analysis in All Tasks & Issues Feb 22, 2024
kumarannathan added a commit to kumarannathan/ndb-core that referenced this issue Dec 10, 2024
Pushing Commit for my EECS481 Partner as they were not able to due to not being a collaborator within github.
Added functionality to DemoDataInitializerService:
    •    Reads demo_entities.json from the assets folder.
    •    Logs a message if the file is found or defaults to the existing hardcoded setup if not.
    •    Prepares for future insertion of JSON data into the database for scenario-specific demo customization.

Co-Authored-By: Mira Panjaitan <[email protected]>
kumarannathan added a commit to kumarannathan/ndb-core that referenced this issue Dec 10, 2024
kumarannathan added a commit to kumarannathan/ndb-core that referenced this issue Dec 10, 2024
Pushing for my partner on the project, as she was not added as a collaborator and couldn't make a PR.

Added functionality to DemoDataInitializerService:
    •    Reads demo_entities.json from the assets folder.
    •    Logs a message if the file is found or defaults to the existing hardcoded setup if not.
    •    Prepares for future insertion of JSON data into the database for scenario-specific demo customization.

Co-Authored-By: Mira Panjaitan <[email protected]>
@sleidig sleidig linked a pull request Dec 10, 2024 that will close this issue
@sleidig sleidig moved this from Triage / Analysis to In Progress in All Tasks & Issues Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Community Help Wanted (good first issue) simple tasks that don't require understanding every last detail of our platform
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

1 participant