diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 61 |
1 files changed, 9 insertions, 52 deletions
@@ -1,63 +1,20 @@ | |||
1 | <img src="./build-helpers/images/icon.png" alt="" width="150"/> | 1 | <img src="./build-helpers/images/icon.png" alt="" width="150"/> |
2 | 2 | ||
3 | # Franz 5 | 3 | # Ferdi |
4 | [![Build status Windows](https://ci.appveyor.com/api/projects/status/9yman4ye19x4274o/branch/master?svg=true)](https://ci.appveyor.com/project/adlk/franz/branch/master) | ||
5 | [![Build Status Mac & Linux](https://travis-ci.com/meetfranz/franz.svg?branch=master)](https://travis-ci.com/meetfranz/franz) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://meetfranz.com/payment.html) | ||
6 | 4 | ||
7 | Messaging app for WhatsApp, Slack, Telegram, HipChat, Hangouts and many many more. | 5 | 👛 Hard-fork of [Franz](https://github.com/meetfranz/franz) removing the non-skippable app delay frequently inviting you to buy a licence |
8 | |||
9 | ## [Download Franz](https://www.meetfranz.com) | ||
10 | 👉 www.meetfranz.com | ||
11 | |||
12 | ### Or use homebrew (macOS only) | ||
13 | |||
14 | `$ brew cask install franz` | ||
15 | |||
16 | (Don't know homebrew? [brew.sh](https://brew.sh/)) | ||
17 | |||
18 | ## Development | ||
19 | |||
20 | ### Preparations | ||
21 | |||
22 | #### Install Linux OS dependencies | ||
23 | [Guide: Linux distribution specific dependencies](docs/linux.md) | ||
24 | |||
25 | #### Fix native modules to match current electron node version | ||
26 | ```bash | ||
27 | $ npm run rebuild | ||
28 | ``` | ||
29 | |||
30 | ### Install dependencies | ||
31 | Run the following command to install all dependencies, and link sibling modules with Franz. | ||
32 | ```bash | ||
33 | $ npx lerna bootstrap | ||
34 | ``` | ||
35 | |||
36 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. | ||
37 | |||
38 | ### Run Franz Development App | ||
39 | Run these two commands __simultaneously__ in different console tabs. | ||
40 | |||
41 | ```bash | ||
42 | $ npm run dev | ||
43 | $ npm run start | ||
44 | ``` | ||
45 | Be aware that the development database will be reset regularly. | ||
46 | 6 | ||
47 | ## Packaging | 7 | ## Packaging |
8 | |||
48 | ```bash | 9 | ```bash |
10 | $ npm install | ||
49 | $ npm run build | 11 | $ npm run build |
50 | ``` | 12 | ``` |
51 | 13 | ||
52 | ## How can I support the project? | 14 | Distributables will be available in the `./out` folder. |
53 | If you have found a bug that hasn't been reported yet or want to request a new feature, please open a new issue. | ||
54 | |||
55 | ## I need help? | ||
56 | Join the Franz community on [Slack](http://slack.franz.im) and get in touch with us. | ||
57 | 15 | ||
58 | ## Create your own plugins/recipes | 16 | ## Features |
59 | You can find all the Information at the [Plugins repository](https://github.com/meetfranz/plugins). | ||
60 | For questions feel free to ask in the [community Slack](http://slack.franz.im) | ||
61 | 17 | ||
62 | ## License | 18 | - [x] Removes the fullscreen app delay inviting users to upgrade |
63 | Franz 5 is open-source licensed under the Apache-2.0 License. | 19 | - [ ] [#5](https://github.com/kytwb/ferdi/issues/5) Makes it optional to create an account |
20 | - [ ] [#6](https://github.com/kytwb/ferdi/issues/6) Makes RocketChat self-hosted generally available | ||