hub / github.com/meetfranz/franz

github.com/meetfranz/franz @v5.11.0 sqlite

repository ↗ · DeepWiki ↗ · release v5.11.0 ↗

1,171 symbols 2,795 edges 329 files 6 documented · 1%

README

Franz 5

Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many more.

Download Franz

👉 www.meetfranz.com

Or use homebrew (macOS only)

$ brew cask install franz

(Don't know homebrew? brew.sh)

Development

Preparations

Install Linux OS dependencies

Guide: Linux distribution specific dependencies

Fix native modules to match current electron node version

$ npm run rebuild

Install dependencies

Run the following command to install all dependencies, and link sibling modules with Franz.

$ npx lerna bootstrap

If you previously ran npm install it sometimes is necessary to delete your node_modules folder before running npx lerna bootstrap.

Run Franz Development App

Run these two commands simultaneously in different console tabs.

$ npm run dev
$ npm run start

Be aware that the development database will be reset regularly.

Packaging

$ npm run build

How can I support the project?

If you have found a bug that hasn't been reported yet or want to request a new feature, please open a new issue.

I need help?

Join the Franz community on Slack and get in touch with us.

Create your own plugins/recipes

You can find all the Information at the Plugins repository. For questions feel free to ask in the community Slack

License

Franz 5 is open-source licensed under the Apache-2.0 License.

Extension points exported contracts — how you extend this code

IStories (Interface)

(no doc)

uidev/src/stores/stories.ts

IStyleTypes (Interface)

(no doc)

packages/theme/src/themes/default/index.ts

ILabel (Interface)

(no doc)

packages/forms/src/label/index.tsx

IProps (Interface)

(no doc)

packages/ui/src/infobox/index.tsx

LoaderOptions (Interface)

(no doc)

packages/typings/types/react-loader.d.ts

IArgs (Interface)

(no doc)

src/electron/ipc-api/overlayWindow.ts

IServiceState (Interface)

(no doc)

src/models/ServiceBrowserView.ts

ISections (Interface)

(no doc)

uidev/src/stores/stories.ts

Core symbols most depended-on inside this repo

execute

called by 47

src/stores/lib/Request.js

src/api/utils/auth.js

invalidate

called by 25

src/stores/lib/CachedRequest.js

get

called by 24

src/electron/Settings.js

one

called by 23

src/stores/ServicesStore.js

update

called by 22

src/api/RecipesApi.js

focus

called by 18

src/models/ServiceBrowserView.ts

Shape

Method 576

Class 308

Function 244

Interface 42

Enum 1

Languages

TypeScript100%

Modules by API surface

src/stores/ServicesStore.js65 symbols

src/stores/UserStore.js38 symbols

src/api/server/ServerApi.js37 symbols

src/stores/AppStore.js29 symbols

src/models/ServiceBrowserView.ts28 symbols

src/lib/Menu.js24 symbols

src/stores/UIStore.js18 symbols

packages/forms/src/select/index.tsx16 symbols

src/features/workspaces/store.js15 symbols

src/stores/RecipesStore.js14 symbols

src/models/Service.js14 symbols

src/stores/SettingsStore.js13 symbols

Dependencies from manifests, versioned

@adlk/misty0.1.1 · 1×

@babel/cli7.0.0 · 1×

@babel/compat-data7.16.4 · 1×

@babel/core7.2.2 · 1×

@babel/plugin-proposal-async-generator-functions7.16.4 · 1×

@babel/plugin-proposal-class-properties7.0.0 · 1×

@babel/plugin-proposal-decorators7.0.0 · 1×

@babel/plugin-proposal-export-default-from7.0.0 · 1×

@babel/plugin-proposal-throw-expressions7.0.0 · 1×

@babel/plugin-syntax-dynamic-import7.0.0 · 1×

@babel/plugin-transform-regenerator7.0.0 · 1×

@babel/polyfill7.4.4 · 1×

For agents

$ claude mcp add franz \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact