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

Finalize new demo app documentation #115

Merged
merged 6 commits into from
May 10, 2023
Merged

Conversation

alonso-cadenas
Copy link
Collaborator

@alonso-cadenas alonso-cadenas commented May 2, 2023

Description

Jira Ticket: CALL-3467

  • Brief overview of each app "purpose", include some code references
  • Add "run in portal" section to both demos
  • Add section about running without installation
  • Add missing SDK events: onReady, error, resize
  • Add disclaimer about the fact we are using mock data and there is no real auth done by the demos

Merge Checklist

Q A
Adds Documentation?
Any Dependency Changes?
Patch: Bug Fix?
Minor: New Feature?
Major: Breaking Change?

BRAVE Checklist

  • I have read the BRAVE checklist and confirmed if the following is necessary.
Q A
Backwards Compatible?
Rollout/Rollback Plan? Merge PR/Revert PR
Automated test coverage?
Verified that changes work?
Expect Dependencies to Fail?

@alonso-cadenas alonso-cadenas changed the base branch from master to project-demo-v1 May 2, 2023 22:04
@github-actions
Copy link

PR Preview Action v1.3.0
🚀 Deployed preview to https://HubSpot.github.io/calling-extensions-sdk/pr-preview/pr-115/
on branch gh-pages at 2023-05-10 15:55 UTC

@alonso-cadenas alonso-cadenas marked this pull request as ready for review May 10, 2023 15:57
@alonso-cadenas alonso-cadenas requested a review from esme May 10, 2023 15:58
@alonso-cadenas alonso-cadenas requested a review from a team as a code owner May 10, 2023 16:07
README.md Outdated Show resolved Hide resolved
@alonso-cadenas alonso-cadenas merged commit d186609 into project-demo-v1 May 10, 2023
@alonso-cadenas alonso-cadenas deleted the call-3467 branch May 10, 2023 18:42
// OR
localStorage.setItem(
"LocalSettings:Calling:installDemoWidget", "local"
'{"name": "Demo Widget Local", "url": "https://localhost:9025/"}'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to make any changes to the DEMO_WIDGET_VALUES?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning is that since we're offering to run the demos with and without installation that there's already a lot of options. In the case that they've installed locally, this command works for both demos, and we can use local and local:js internally. Happy to change it back if you prefer.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah we do have a lot of options for installing locally. I was just wondering if you had in mind the idea to combine local and local:js when I saw this change

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see! I can do that. I'll simplify to these:

export enum DEMO_WIDGET_VALUES {
  APP_MINIMAL_JS = 'app:js',
  APP_REACT_TS = 'app',
  LOCAL = 'local',
}

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then I'll update this README

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alonso-cadenas added a commit that referenced this pull request May 22, 2023
* Host demo app on GitHub Pages

* Create demo app UI using React and TS (#63)

* Create demo app UI using React and TS

* Deploy demo apps to GH pages (#65)

* Deploy React app to GitHub Pages

* Set up webpack config and node scripts to output demo apps in common build folder

* Configure gh-pages in calling-extensions-sdk

* Setup a testing suite for the demo app (#68)

* Set up unit test framework and automate tests

* Deploy to gh pages automatically

* Separate workflows for previews and deploys

* Use npm ci

* Add cross-env

* Run test:serve with --watch

* Add minimal phone number validation to keypad (#71)

* Add minimal phone number validation to keypad

* Add test

* Update event console logging (#70)

* Update event handling console log messages

* Move logging to iframe manager

* Demo console banner (#78)

* Add developer console banner

* Preview all branches with demo keyword

* Close widget after saving call

* Send additional call engagement properties in callCompletedData (#79)

* Demo app icons (#84)

* Add icons to demo app

* Deploy from build folder

* Add keypad to call actions

* Backfill unit tests (#86)

* Backfill unit tests

* Fix createEngagement called twice (#87)

* Fix after rebase

* Offer both demo apps (#88)

* Add fake number to the From Numbers dropdown (#93)

* Add fake numbers to the From Number dropdown

* Update demos to use latest sdk package version (#96)

* Use latest package version

* Temporarily comment out imports for local dev

* Update patch dependencies

* Make errorType import easier

* Organize NPM scripts in the demo app (#95)

* Organize NPM scripts in the demo app

* Merge changes from master branch (#102)

* Merge changes from master branch

* Rename __tests__ to dist-test

* Demo readme (#104)

* Add documentation for demo widgets

* Publish new alpha version (#105)

* Use 0.0.15-alpha.1

---------

Co-authored-by: Alonso Cadenas <cadenas.alonso@gmail.com>

* Rename demo widgets (#106)

* Rename demo widgets

* Fix demo app build warnings and iFrame uninitialized message (#107)

* Fix build warnings and iFrame uninitialized message

* Optimize config for dev or prod build

* Send callStartTime in outgoingCall message (#108)

* Send callStartTime in outgoingCall message

* Specify minimum required Node.js version (#109)

* Specify minimum required Node.js version to maintain compatibility with dependencies

* Remove node_options

* Remove demo folder

* Update webpack config to serve static files from the public directory (#114)

* Enforce order of events in demo minimal js (#113)

* Enforce order of events in demo minimal js

* Finalize new demo app documentation (#115)

* Add missing events

* Finalize demo app documentation

* Update diction

* Omit line number

* Use new local value to install the demo widget (#117)

* Use local value to install demo widget

* Fix spacing

* Fix spacing

* Add ability to publish prerelease versions to npm (#118)

* Simplify publish scripts and add prerelease scripts.

* pre-releases should be published as alpha versions

* 0.0.15-alpha.2

* 0.0.15-alpha.3

* 0.0.15-beta.0

* 0.1.0-0

* 0.1.0-alpha.0

* 0.1.0-beta.0

* prepatch already exists via alpha and beta commands

* 0.1.0

* Enable github actions (#120)

* Enable github actions

* Use latest sdk version in demos

* Set versions for demos

* Update demo documentation (#121)

* Update demo docs

* Enable branch previews

* test gha (#124)

* test gha

* Enable github action deploy previews

* Revert "test gha"

This reverts commit ca86ab0.

---------

Co-authored-by: Esme Ling <esmelingyr@gmail.com>
Co-authored-by: Esme <23175119+esme@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants