Skip to content

Commit

Permalink
PF-1391 - Iterating on README with folder structure
Browse files Browse the repository at this point in the history
  • Loading branch information
fredcido committed Nov 20, 2023
1 parent 248219b commit 70d4831
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions examples/breakout-rooms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ https://github.com/miroapp/app-examples/assets/7162412/46b1708d-fb08-412e-a7b2-3
- [Attention Management](TODO)
- [Real-time events](TODO)
- [Real-time storage](TODO)
- [Timer](TODO)

# πŸ› οΈ Tools and Technologies <a name="tools"></a>

Expand Down Expand Up @@ -91,12 +92,20 @@ scopes:
```
.
β”œβ”€β”€ src
β”‚ └── index.tsx <-- Where the custom actions and icon click handler are defined.
β”‚ └── app.tsx <-- Where the selfie is taken and the image created/updated
β”œβ”€β”€ tsconfig.json <-- typescript configuration file
β”œβ”€β”€ vite.config.ts <-- Vite configuration file
└── index.html <-- The app entry point. This is the value you assign to 'sdkUri' in the app manifest file.
└── capture.html <-- The content displayed in the modal to capture your selfie.
β”‚ β”œβ”€β”€ components
β”‚ β”‚ β”œβ”€β”€ BreakoutManager.tsx <-- Main React component displayed in the panel to facilitators
β”‚ β”‚ β”œβ”€β”€ ErrorBoundary.tsx <-- React error Boundary
β”‚ β”‚ β”œβ”€β”€ RoomConfig.tsx <-- React component to allow users to configure the rooms.
β”‚ β”‚ β”œβ”€β”€ Timer.tsx <-- React component to configure the timer.
β”‚ β”‚ └── WaitingRoom.tsx <-- React component displayed to other users in the board but the facilitator creating breakout rooms.
β”‚ β”œβ”€β”€ app.tsx <-- The app typescript entrypoint used in the panel.
β”‚ β”œβ”€β”€ hooks.tsx <-- React hooks used in the app, including useCurrentUser, useBreakout, useTimer and some others.
β”‚ β”œβ”€β”€ index.ts <-- The app main typescript entrypoint, rendered inside the headless iframe.
β”‚ β”œβ”€β”€ types.ts <-- The app typescript types.
β”‚ └── utils.ts <-- General code utilities, such as formatting and converting time in different units.
β”œβ”€β”€ app.html <-- The app content displayed in the content when user clicks on the app icon on Miro boards.
β”œβ”€β”€ index.html <-- The app entry point. This is the value you assign to 'sdkUri' in the app manifest file.

```

# πŸ«±πŸ»β€πŸ«²πŸ½ Contributing <a name="contributing"></a>
Expand Down

0 comments on commit 70d4831

Please sign in to comment.