diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 82 |
1 files changed, 42 insertions, 40 deletions
@@ -4,66 +4,67 @@ | |||
4 | 4 | ||
5 | # Ferdi | 5 | # Ferdi |
6 | 6 | ||
7 | [![Build Status Windows](https://ci.appveyor.com/api/projects/status/2ckfbmoxp36fye5b?svg=true)](https://ci.appveyor.com/project/kytwb/ferdi) | ||
8 | [![Build Status Mac & Linux](https://travis-ci.org/kytwb/ferdi.svg?branch=master)](https://travis-ci.org/kytwb/ferdi) | ||
9 | |||
7 | 🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted features. | 10 | 🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted features. |
8 | 11 | ||
12 | ## Download Ferdi | ||
13 | |||
14 | You can find the installers in the [latest release](https://github.com/kytwb/ferdi/releases) assets. | ||
15 | |||
16 | ### Or use homebrew (macOS only) | ||
17 | |||
18 | `$ brew cask install ferdi` | ||
19 | |||
20 | (Don't know homebrew? [brew.sh](https://brew.sh/)) | ||
21 | |||
9 | ## Features | 22 | ## Features |
10 | - [x] Removes the counter-productive fullscreen app delay inviting users to upgrade | 23 | - [x] Removes the counter-productive fullscreen app delay inviting users to upgrade |
11 | - [x] Removes pages begging you to donate after registration | 24 | - [x] Removes pages begging you to donate after registration |
12 | - [x] Remove "Franz is better together" popup | ||
13 | - [x] Makes all users Premium by default | 25 | - [x] Makes all users Premium by default |
14 | - [x] [Makes it possible to edit the "Franz Todo" server](#franz-todo) | 26 | - [x] [Add option to change server to a custom](https://github.com/kytwb/ferdi/wiki/Custom-Server) [ferdi-server](https://github.com/vantezzen/ferdi-server) |
15 | - [x] [Add option to change server to a custom](#servers) [ferdi-server](https://github.com/vantezzen/ferdi-server) | ||
16 | - [x] Add "Private Notification"-Mode, that hides message content from notifications (as suggested in [meetfranz/franz#879](https://github.com/meetfranz/franz/issues/879)) | 27 | - [x] Add "Private Notification"-Mode, that hides message content from notifications (as suggested in [meetfranz/franz#879](https://github.com/meetfranz/franz/issues/879)) |
28 | - [x] Remove "Franz is better together" popup | ||
29 | - [x] [Makes it possible to edit the "Franz Todo" server](https://github.com/kytwb/ferdi/wiki/Custom-Todo) | ||
17 | - [x] Makes RocketChat self-hosted generally available | 30 | - [x] Makes RocketChat self-hosted generally available |
18 | - [x] Comes with a custom branding proper to Ferdi | 31 | - [x] Comes with a custom branding proper to Ferdi |
19 | 32 | ||
20 | ### Servers | 33 | ## Development |
21 | Ferdi adds the option to change your Ferdi server. By default, this will be `https://api.franzinfra.com` - the official Franz server. This allows Ferdi to stay compatible with your current Franz account. | 34 | |
35 | ### Preparations | ||
36 | |||
37 | #### Install Linux OS dependencies | ||
38 | [Guide: Linux distribution specific dependencies](docs/linux.md) | ||
22 | 39 | ||
23 | If you want to experience all Ferdi features, you may want to use a custom [ferdi-server](https://github.com/vantezzen/ferdi-server). ferdi-server allows you to use Premium features without restrictions and adds the ability to package and add additional recipes. You can also import your existing Franz account into your ferdi-server to start right where you left off. | 40 | #### Fix native modules to match current electron node version |
41 | ```bash | ||
42 | $ npm run rebuild | ||
43 | ``` | ||
24 | 44 | ||
25 | More information on how to set up a ferdi-server can be found at <https://github.com/vantezzen/ferdi-server/blob/master/README.md>. | 45 | ### Install dependencies |
46 | Run the following command to install all dependencies, and link sibling modules with Franz. | ||
47 | ```bash | ||
48 | $ npx lerna bootstrap | ||
49 | ``` | ||
26 | 50 | ||
27 | ### Franz Todo | 51 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. |
28 | Starting with Franz 5.3.0, Franz ships with the "Franz Todo" feature. This feature allows you to create a Franz Todo list that stays open at all times. | ||
29 | 52 | ||
30 | Ferdi makes it possible to change the Franz Todo list server to any URL you want, e.g. to `todoist.com` to use your Todoist todo list in Franz todo. | 53 | ### Run Ferdi Development App |
54 | Run these two commands __simultaneously__ in different console tabs. | ||
31 | 55 | ||
32 | ![Todoist in Franz Todo](screenshots/Ferdi-Todo.png) | 56 | ```bash |
57 | $ npm run dev | ||
58 | $ npm run start | ||
59 | ``` | ||
60 | Be aware that the development database will be reset regularly. | ||
33 | 61 | ||
34 | ## Packaging | 62 | ## Packaging |
35 | |||
36 | ```bash | 63 | ```bash |
37 | $ npm install | ||
38 | $ npm run build | 64 | $ npm run build |
39 | ``` | 65 | ``` |
40 | 66 | ||
41 | Deliverables will be available in the `./out` folder. | 67 | Deliverables will be available in the ./out folder. |
42 | |||
43 | ## Developing | ||
44 | ### Preparations | ||
45 | - [Install Linux dependencies](docs/linux.md) if you are developing on Linux | ||
46 | - Make sure you are running NodeJS v10. Versions above will throw an errow when trying to install due to an [old fsevent dependency](https://github.com/fsevents/fsevents/issues/278) | ||
47 | |||
48 | ### Setup | ||
49 | 1. Fix native modules to match current electron node version | ||
50 | ``` | ||
51 | npm run rebuild | ||
52 | ``` | ||
53 | 2. Install dependencies using lerna | ||
54 | ``` | ||
55 | npx lerna bootstrap | ||
56 | ``` | ||
57 | 3. Run Ferdi Development App | ||
58 | Run these two commands *simultaneously* in different console tabs. | ||
59 | ``` | ||
60 | npm run dev | ||
61 | npm run start | ||
62 | ``` | ||
63 | |||
64 | ## Releases | ||
65 | |||
66 | 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. | ||
67 | 68 | ||
68 | ## Contributors ✨ | 69 | ## Contributors ✨ |
69 | 70 | ||
@@ -73,9 +74,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d | |||
73 | <!-- markdownlint-disable --> | 74 | <!-- markdownlint-disable --> |
74 | <table> | 75 | <table> |
75 | <tr> | 76 | <tr> |
76 | <td align="center"><a href="https://twitter.com/kytwb"><img src="https://avatars0.githubusercontent.com/u/412895?v=4" width="100px;" alt="Amine Mouafik"/><br /><sub><b>Amine Mouafik</b></sub></a><br /><a href="#question-kytwb" title="Answering Questions">💬</a> <a href="https://github.com/kytwb/ferdi/commits?author=kytwb" title="Code">💻</a> <a href="https://github.com/kytwb/ferdi/commits?author=kytwb" title="Documentation">📖</a> <a href="#ideas-kytwb" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-kytwb" title="Maintenance">🚧</a> <a href="#platform-kytwb" title="Packaging/porting to new platform">📦</a> <a href="#projectManagement-kytwb" title="Project Management">📆</a> <a href="#review-kytwb" title="Reviewed Pull Requests">👀</a></td> | ||
77 | <td align="center"><a href="https://vantezzen.io"><img src="https://avatars2.githubusercontent.com/u/10333196?v=4" width="100px;" alt="Bennett"/><br /><sub><b>Bennett</b></sub></a><br /><a href="https://github.com/kytwb/ferdi/commits?author=vantezzen" title="Code">💻</a> <a href="#design-vantezzen" title="Design">🎨</a> <a href="https://github.com/kytwb/ferdi/commits?author=vantezzen" title="Documentation">📖</a> <a href="#ideas-vantezzen" title="Ideas, Planning, & Feedback">🤔</a> <a href="#translation-vantezzen" title="Translation">🌍</a></td> | 77 | <td align="center"><a href="https://vantezzen.io"><img src="https://avatars2.githubusercontent.com/u/10333196?v=4" width="100px;" alt="Bennett"/><br /><sub><b>Bennett</b></sub></a><br /><a href="https://github.com/kytwb/ferdi/commits?author=vantezzen" title="Code">💻</a> <a href="#design-vantezzen" title="Design">🎨</a> <a href="https://github.com/kytwb/ferdi/commits?author=vantezzen" title="Documentation">📖</a> <a href="#ideas-vantezzen" title="Ideas, Planning, & Feedback">🤔</a> <a href="#translation-vantezzen" title="Translation">🌍</a></td> |
78 | <td align="center"><a href="http://www.adlk.io"><img src="https://avatars1.githubusercontent.com/u/3265004?v=4" width="100px;" alt="Stefan Malzner"/><br /><sub><b>Stefan Malzner</b></sub></a><br /><a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Code">💻</a> <a href="#content-adlk" title="Content">🖋</a> <a href="#design-adlk" title="Design">🎨</a> <a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Documentation">📖</a> <a href="#ideas-adlk" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-adlk" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#projectManagement-adlk" title="Project Management">📆</a> <a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Tests">⚠️</a> <a href="#translation-adlk" title="Translation">🌍</a></td> | 78 | <td align="center"><a href="http://www.adlk.io"><img src="https://avatars1.githubusercontent.com/u/3265004?v=4" width="100px;" alt="Stefan Malzner"/><br /><sub><b>Stefan Malzner</b></sub></a><br /><a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Code">💻</a> <a href="#content-adlk" title="Content">🖋</a> <a href="#design-adlk" title="Design">🎨</a> <a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Documentation">📖</a> <a href="#ideas-adlk" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-adlk" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#projectManagement-adlk" title="Project Management">📆</a> <a href="https://github.com/kytwb/ferdi/commits?author=adlk" title="Tests">⚠️</a> <a href="#translation-adlk" title="Translation">🌍</a></td> |
79 | <td align="center"><a href="https://twitter.com/kytwb"><img src="https://avatars0.githubusercontent.com/u/412895?v=4" width="100px;" alt="Amine Mouafik"/><br /><sub><b>Amine Mouafik</b></sub></a><br /><a href="#question-kytwb" title="Answering Questions">💬</a> <a href="https://github.com/kytwb/ferdi/commits?author=kytwb" title="Code">💻</a> <a href="https://github.com/kytwb/ferdi/commits?author=kytwb" title="Documentation">📖</a> <a href="#ideas-kytwb" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-kytwb" title="Maintenance">🚧</a> <a href="#platform-kytwb" title="Packaging/porting to new platform">📦</a> <a href="#projectManagement-kytwb" title="Project Management">📆</a> <a href="#review-kytwb" title="Reviewed Pull Requests">👀</a></td> | ||
80 | <td align="center"><a href="http://seriesgt.com"><img src="https://avatars3.githubusercontent.com/u/5977640?v=4" width="100px;" alt="ZeroCool"/><br /><sub><b>ZeroCool</b></sub></a><br /><a href="https://github.com/kytwb/ferdi/commits?author=ZeroCool940711" title="Code">💻</a> <a href="#ideas-ZeroCool940711" title="Ideas, Planning, & Feedback">🤔</a></td> | ||
79 | </tr> | 81 | </tr> |
80 | </table> | 82 | </table> |
81 | 83 | ||