PE-322: HTML5 example integrated into dev-cookbook

jdmedlin1 commented 6 months ago

📝 Description

The changes in this PR are intended to migrate the frontend of bs-exmaple-wss to an example directory in this repository. As the frontend did not have any tests, the test script is currently bypassed.

Issue: Url to Jira Issue

📋 List of Changes

Added project called example-html5-app
Modified dev-cookbook eslintrc to allow ts extensions in imports
Modified node scripts in html5 example from their original repo (bs-example-wss)
- test, format, format:check, lint, and publish

🧪 Steps to Test

There are no tests for this example as it was migrated over from another repository and did not have tests there either. Adding tests may not be encompassed in this effort.

Notes to the Reviewer

📸 Screenshots

✔️ Dev Complete Checklist

[ ] PR template filled out
[ ] Change is tested by submitter
[ ] PR follows all linting and coding standards
[ ] Github Issue exists (if applicable)
[ ] Team member has been assigned
[ ] At least one commit message is in Conventional Commit format

jdmedlin1 commented 5 months ago

The latest change to this PR is adding babel to convert the Typescript project into Javascript. This method of supporting a Javascript version of the html template avoids any outdating of either language of the template. In terms of adding mocks to this effort based off firmware IDLs, I am thinking we possibly use swagger-mock-generator, but should we store the IDLs in this monorepo or access them each time we want to update the mock classes?

mingjun7 commented 5 months ago

Looks like there are some github actions failed. @jdmedlin1 please check them out.

WRT the changes overall, this is a bit different than what I thought will be made. Although it says it's a template, the html included will display an example application. Maybe I'm not clear on the definition of template vs example.

jdmedlin1 commented 5 months ago

There looks like still some open questions for the implementation where I don't see the changes in the latest patches:

how to manage the typescript vs javascript example

This will be done in a separate PR captured in effort PE-314

where do we consolidate the player OS API type definition

I am not sure I understand what you mean by player OS API type definition. IDLs? Which APIs are you referring to?

how do we provide user instructions to setup players in general

We should point the root readme to a document that already exists as we would like to avoid maintaining a redundant instruction.

what's the main difference between a template vs example project

@brightsign/bs-partner-engineering shall we make a writeup/document for us to reference and improve? The primary difference in my mind between a template and an example is the intention of its use. This is still a bit difficult for me to objectively discern.

mingjun7 commented 5 months ago

There looks like still some open questions for the implementation where I don't see the changes in the latest patches:

how to manage the typescript vs javascript example

This will be done in a separate PR captured in effort PE-314

where do we consolidate the player OS API type definition

I am not sure I understand what you mean by player OS API type definition. IDLs? Which APIs are you referring to?

how do we provide user instructions to setup players in general

We should point the root readme to a document that already exists as we would like to avoid maintaining a redundant instruction.

what's the main difference between a template vs example project

@brightsign/bs-partner-engineering shall we make a writeup/document for us to reference and improve? The primary difference in my mind between a template and an example is the intention of its use. This is still a bit difficult for me to objectively discern.

I am not sure I understand what you mean by player OS API type definition. IDLs? Which APIs are you referring to?

I'm referring to the mock OS classes. What's the plan to consolidate them?

We should point the root readme to a document that already exists as we would like to avoid maintaining a redundant instruction.

I agree but I don't see that being implemented. Are you planning to do on a different ticket?

jdmedlin1 commented 5 months ago

There looks like still some open questions for the implementation where I don't see the changes in the latest patches:

how to manage the typescript vs javascript example

This will be done in a separate PR captured in effort PE-314

where do we consolidate the player OS API type definition

I am not sure I understand what you mean by player OS API type definition. IDLs? Which APIs are you referring to?

how do we provide user instructions to setup players in general

We should point the root readme to a document that already exists as we would like to avoid maintaining a redundant instruction.

what's the main difference between a template vs example project

@brightsign/bs-partner-engineering shall we make a writeup/document for us to reference and improve? The primary difference in my mind between a template and an example is the intention of its use. This is still a bit difficult for me to objectively discern.

I am not sure I understand what you mean by player OS API type definition. IDLs? Which APIs are you referring to?

I'm referring to the mock OS classes. What's the plan to consolidate them?

Which mock OS classes are you referring to? If we are looking to integrate OS mocks into this repository, that should be covered in another ticket so we can set it up for all projects, not just html template.

We should point the root readme to a document that already exists as we would like to avoid maintaining a redundant instruction.

I agree but I don't see that being implemented. Are you planning to do on a different ticket?

This is now in PE-314

jdmedlin1 commented 5 months ago

@mingjun7 I'll be consolidating mocks and categorizing between individual and root readme information in PE-314

brightsign / dev-cookbook