Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mligtenberg committed Jan 12, 2025
1 parent 7c4116a commit 63da656
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 14 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,20 @@
</div>

This project aims to build a cross platform tool to manage Azure Servicebus instances.
Currently you are able to:
- View your queues, topics and subscriptions
- View the details of your queues, topics and subscriptions
Currently, you are able to:
- View and manage your queues, topics, subscriptions and subscription rules
- Peek (View without deleting) messages in your queues and subscriptions. From the main, deadletter and trasfered dead letter channels
- Send messages to your queues and topics
- Clear messages from your queues and subscriptions

## How to run
### Installer
Download the Windows, Linux versions of the app here:
- https://github.com/mligtenberg/ServicebusBrowser/releases

For mac users a manual release is advised for now
since the build is required to be signed.

### Manual build (release build)
#### Requirements
- Node V20
- PNPM V9
- Node V22
- PNPM V10

#### Steps
- Clone the project
Expand All @@ -37,5 +33,5 @@ since the build is required to be signed.
- Clone the project
- Install the dependencies with ``pnpm install`` in the main directory
- Build and start the project by running ``pnpm exec nx run-many -t serve`` in the main directory
- A electron window should open with the app running
- An electron window should open with the app running
- you might need to hit Ff (or CMD + R on mac) to refresh the window, this is a timing issue caused by the dev server
4 changes: 2 additions & 2 deletions apps/servicebus-browser-app/src/app/menu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const macTemplate: Array<MenuItemConstructorOptions | MenuItem> = [
}
];

const winlinTemplate: Array<MenuItemConstructorOptions | MenuItem> = [
const winLinTemplate: Array<MenuItemConstructorOptions | MenuItem> = [
// { role: 'fileMenu' }
{
label: 'File',
Expand All @@ -37,4 +37,4 @@ const winlinTemplate: Array<MenuItemConstructorOptions | MenuItem> = [
}
];

export const menu = Menu.buildFromTemplate(isMac ? macTemplate : winlinTemplate);
export const menu = Menu.buildFromTemplate(isMac ? macTemplate : winLinTemplate);
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@
"preinstall": "npx only-allow pnpm"
},
"engines": {
"node": ">=20",
"pnpm": ">=9"
"node": ">=22",
"pnpm": ">=10"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit 63da656

Please sign in to comment.