Updating the readme for smoother onboarding to the repo #2739
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RickyRoller
commented
Mar 3, 2025
Comment on lines
22
to
29
| 1. follow the getting started steps above and make sure you have a running zOS instance. | ||
| 1. add a repo for your new app. you can copy the feed app to get the basics, or just start from scratch. | ||
| 1. an app is just a component that conforms to the interface required by the platform. once you have the basics of your app in place, you can add it to the platform to make sure it loads correctly: | ||
| 1. add your package, and import in [src/app-sandbox/index.tsx](src/app-sandbox/index.tsx) | ||
| 1. add a conditional to the `renderSelectedApp` method that returns your component. if your app is covered by the default apps set, then use the corresponding member of the Apps enum. | ||
| 1. add your app to the allApps array in [src/lib/apps/index.ts](src/lib/apps/index.ts) | ||
| 1. make sure your app shows up in the menu, and that you can access it when the menu item is clicked. | ||
| 1. create a new folder for your app in [src/apps](https://github.com/zer0-os/zOS/tree/main/src/apps) | ||
| - if your app is externally hosted, create an index.tsx file that uses the [ExternalApp](https://github.com/zer0-os/zOS/blob/main/src/apps/external-app/index.tsx) component and points to your app. | ||
| 1. add your app component to the [AppRouter](https://github.com/zer0-os/zOS/blob/main/src/apps/app-router.tsx) | ||
| 1. add a link to your app in the [AppBar](https://github.com/zer0-os/zOS/blob/3ace5002ed7561d3e0e3671982e3ee755fb97048/src/components/app-bar/index.tsx) | ||
| 1. once you have a stable version of your app, you can create a PR to the core zOS repo with the platform changes, and the version of your app you would like released. |
There was a problem hiding this comment.
Let me know if anything here is off. This section seemed like it was written for external app developers, so I included some references to the ExternalApp component, but it should be helpful for others writing internal apps as well
domw30
approved these changes
Mar 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this do?
Updating the readme to include some missing info and to correct some outdated info.
Why are we making this change?
To make onboarding to the repo a bit smoother