blob: 5397189c69ac5a101ec54c778bb5de34b7dfb8c2 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
<img src="./build-helpers/images/icon.png" alt="" width="150"/>
# Franz 5
[](https://ci.appveyor.com/project/adlk/franz/branch/master)
[](https://travis-ci.com/meetfranz/franz) [](https://meetfranz.com/payment.html)
Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many more.
## [Download Franz](https://www.meetfranz.com)
👉 www.meetfranz.com
### Or use homebrew (macOS only)
`$ brew cask install franz`
(Don't know homebrew? [brew.sh](https://brew.sh/))
## Development
### Preparations
#### Install Linux OS dependencies
[Guide: Linux distribution specific dependencies](docs/linux.md)
#### Fix native modules to match current electron node version
```bash
$ npm run rebuild
```
### Install dependencies
Run the following command to install all dependencies, and link sibling modules with Franz.
```bash
$ 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.
```bash
$ npm run dev
$ npm run start
```
Be aware that the development database will be reset regularly.
## Packaging
```bash
$ 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](http://slack.franz.im) and get in touch with us.
## Create your own plugins/recipes
You can find all the Information at the [Plugins repository](https://github.com/meetfranz/plugins).
For questions feel free to ask in the [community Slack](http://slack.franz.im)
## License
Franz 5 is open-source licensed under the Apache-2.0 License.
|
