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

feat(docs): add guide for creating an app with Juno UI Components #679

Merged
merged 11 commits into from
Jan 8, 2025

Conversation

ArtieReus
Copy link
Collaborator

@ArtieReus ArtieReus commented Dec 12, 2024

Summary

This PR introduces documentation on how to create an app using Juno UI Components. The guide covers the setup process, including adding dependencies, configuring Vite, and integrating Juno-specific providers and components into your application.

This PR does not include any interface descriptions or instructions for integrating the app with Greenhouse or Aurora. Future documentation updates may cover these integrations as needed.

Changes Made

  • Added a step-by-step guide for creating an app with Juno UI Components.

Checklist

  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • I have made corresponding changes to the documentation (if applicable).
  • My changes generate no new warnings or errors.

@ArtieReus ArtieReus requested a review from a team as a code owner December 12, 2024 09:02
Copy link

changeset-bot bot commented Dec 12, 2024

⚠️ No Changeset found

Latest commit: 3db3589

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ArtieReus ArtieReus self-assigned this Dec 12, 2024
@ArtieReus ArtieReus added the documentation Improvements or additions to documentation label Dec 12, 2024
Copy link
Contributor

PR Preview Action v1.4.8
🚀 Deployed preview to https://cloudoperators.github.io/juno/pr-preview/pr-679/
on branch gh-pages at 2024-12-12 09:05 UTC

@ArtieReus
Copy link
Collaborator Author

@edda do you want to mention anything about the app props embedded and fullWidthContent for the AppShell?

andypf
andypf previously approved these changes Dec 19, 2024
Copy link
Collaborator

@andypf andypf left a comment

Choose a reason for hiding this comment

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

Great!

@andypf
Copy link
Collaborator

andypf commented Dec 19, 2024

@ArtieReus, could you please add a section about bundling? Specifically:

  • Standalone Applications: For standalone applications, all libraries should be bundled directly into the application.
  • Host-Dependent Applications: If the application is designed to run on a host that already provides certain libraries, these libraries should not be bundled. Instead, they should be added to the peerDependencies section.

@andypf andypf dismissed their stale review December 19, 2024 12:57

found an issue

edda
edda previously approved these changes Dec 19, 2024
Copy link
Contributor

@edda edda left a comment

Choose a reason for hiding this comment

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

I like it a lot! Very good instructions.
Only thing missing is the info about differences in bundling when building for standalone vs. embedded <- @andypf

Copy link
Contributor

@barsukov barsukov left a comment

Choose a reason for hiding this comment

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

LGTM from my side make some changes that was requested and we are good to go

@edda
Copy link
Contributor

edda commented Dec 20, 2024

@edda do you want to mention anything about the app props embedded and fullWidthContent for the AppShell?

Ah yeah, good point. I think it's enough to mention that those props exist and to check the storybook documentation of AppShell for more details (what they do is documented there)

barsukov
barsukov previously approved these changes Jan 3, 2025
Copy link
Contributor

@edda edda left a comment

Choose a reason for hiding this comment

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

Perfect! One small suggestion to make it a bit clearer what people can expect from our host apps.

docs/create-your-own-app.md Outdated Show resolved Hide resolved
Co-authored-by: Esther Schmitz <edda@users.noreply.github.com>
@barsukov barsukov merged commit 845a619 into main Jan 8, 2025
13 checks passed
@barsukov barsukov deleted the artie-create-external-app branch January 8, 2025 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants