diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 63 |
1 files changed, 12 insertions, 51 deletions
| @@ -1,63 +1,24 @@ | |||
| 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 | [](https://ci.appveyor.com/project/adlk/franz/branch/master) | ||
| 5 | [](https://travis-ci.com/meetfranz/franz) [](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 | Deliverables 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. | 15 | |
| 16 | ## Releases | ||
| 54 | 17 | ||
| 55 | ## I need help? | 18 | You can find the binaries for Linux, MacOS and Windows in the [latest release](https://github.com/kytwb/ferdi/releases/tag/Ferdi-5.2.0-beta.3) assets. Assets are continuously delivered through [Travis](https://travis-ci.org/kytwb/ferdi) for Linux/MacOS and [Appveyor](https://ci.appveyor.com/project/kytwb/ferdi) for Windows. |
| 56 | Join the Franz community on [Slack](http://slack.franz.im) and get in touch with us. | ||
| 57 | 19 | ||
| 58 | ## Create your own plugins/recipes | 20 | ## 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 | 21 | ||
| 62 | ## License | 22 | - [x] Removes the fullscreen app delay inviting users to upgrade |
| 63 | Franz 5 is open-source licensed under the Apache-2.0 License. | 23 | - [ ] [#5](https://github.com/kytwb/ferdi/issues/5) Makes it optional to create an account |
| 24 | - [ ] [#6](https://github.com/kytwb/ferdi/issues/6) Makes RocketChat self-hosted generally available | ||