Skip to content

[App Extensibility] Starter Extension + Clean up + Readme's (@W-17018677@)#2188

Merged
bendvc merged 27 commits intofeature/extensibility-v2from
bendvc/extension-starter
Jan 14, 2025
Merged

[App Extensibility] Starter Extension + Clean up + Readme's (@W-17018677@)#2188
bendvc merged 27 commits intofeature/extensibility-v2from
bendvc/extension-starter

Conversation

@bendvc
Copy link
Contributor

@bendvc bendvc commented Jan 7, 2025

Description

Used #2184 as a jumping off point for this PR.

The goal of this PR is to add relevant readme's to the application extension starter project as it serves as a template for generating extensions. This helps with getting closer to "readme driven learning" for our beta program.

Types of Changes

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Documentation update
  • Breaking change (could cause existing functionality to not work as expected)
  • Other changes (non-breaking changes that does not fit any of the above)

Changes

  • Adding various readme's for extension assets, config, etc
  • Merged extension-base and extension-sample projects into one single project called extension-starter
  • Updated all references to missing projects.

How to Test-Drive This PR

  • The best way to test this PR is to generate an extension project using the following command:
  • node packages/pwa-kit-create-app/scripts/create-mobify-app-dev.js --outputDir generated-application-extension
  • Ensure you select "Application Extension" when asked.
  • Once generated, ensure all the readme's added in this PR are in your resultant project.

Copy link
Contributor

@adamraya adamraya Jan 8, 2025

Choose a reason for hiding this comment

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

Do you want to update the references to the Sample extension with the Extension starter, including the ASCII art?

 __                       _          __      _                 _             
/ _\ __ _ _ __ ___  _ __ | | ___    /__\_  _| |_ ___ _ __  ___(_) ___  _ __  
\ \ / _` | '_ ` _ \| '_ \| |/ _ \  /_\ \ \/ / __/ _ \ '_ \/ __| |/ _ \| '_ \ 
_\ \ (_| | | | | | | |_) | |  __/ //__  >  <| ||  __/ | | \__ \ | (_) | | | |
\__/\__,_|_| |_| |_| .__/|_|\___| \__/ /_/\_\\__\___|_| |_|___/_|\___/|_| |_|
                   |_|                                                       

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call.. I'll get on that.

@adamraya
Copy link
Contributor

adamraya commented Jan 9, 2025

I see a few references to "extension-sample". Do we want to update those since we removed extension-sample?

@adamraya
Copy link
Contributor

adamraya commented Jan 9, 2025

Do you want to update the "SampleExtension" class name in setup-server.ts?

class SampleExtension extends ApplicationExtension<Config> {

@bendvc
Copy link
Contributor Author

bendvc commented Jan 9, 2025

I see a few references to "extension-sample". Do we want to update those since we removed extension-sample?

Ahh yes.. I didn't prioritize those because they were tests and mock data. But I can update those. Thanks for being the eagle eye 🦅

@bendvc bendvc added the skip changelog Skip the "Changelog Check" GitHub Actions step even if the Changelog.md files are not updated label Jan 10, 2025
@bendvc bendvc merged commit 7ae5802 into feature/extensibility-v2 Jan 14, 2025
23 of 26 checks passed
@bendvc bendvc deleted the bendvc/extension-starter branch January 14, 2025 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip changelog Skip the "Changelog Check" GitHub Actions step even if the Changelog.md files are not updated

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants