aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: ee3e0c05268a590d536898690995953c151f9833 (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
**This repository is only for Franz 5 and later, previous versions are no longer maintained.**
---

<img src="./build-helpers/images/icon.png" alt="" width="150"/>

# Franz 5 (beta)
[![Build status Windows](https://ci.appveyor.com/api/projects/status/9yman4ye19x4274o/branch/master?svg=true)](https://ci.appveyor.com/project/adlk/franz/branch/master)
 [![Build Status Mac](https://travis-ci.com/meetfranz/franz.svg?token=9zxYPVb6RdKVnmTFMJLX&branch=master)](https://travis-ci.com/meetfranz/franz) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](http://meetfranz.com/payment.html)

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


## Development

### Preparations
#### Install yarn
##### MacOS
```bash
$ brew install yarn
```
##### Windows
[Download installer](https://yarnpkg.com/latest.msi)

#### Install Gulp 4
```bash
$ yarn add global gulp-cli@1.2.2
$ yarn add global gulpjs/gulp#4.0
```


### Run Franz Development App
Run these two commands __simultaneously__ in different console tabs.

```bash
$ yarn run dev
$ yarn start
```

## Packaging
```bash
$ yarn build
```

## How can I support the project?
If you have found a bug that hasn't been reported yet, please open a new issue.

## I need help?
Join the Franz community on [Slack](https://slack.franz.im) and get in touch with us.

## Next steps
- [ ] Create acceptance tests
- [ ] 5.0 stable release
- [ ] Developer Documentation

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