diff options
author | 2019-09-10 17:18:58 +0700 | |
---|---|---|
committer | 2019-09-10 17:18:58 +0700 | |
commit | ad2e5caacf1f5b90d97e11d3377756c054459ff4 (patch) | |
tree | 1f1072859b7c0d33a774dc466fd275e885c0c17a | |
parent | Merge branch 'master' into franz-5.3.0 (diff) | |
download | ferdium-app-ad2e5caacf1f5b90d97e11d3377756c054459ff4.tar.gz ferdium-app-ad2e5caacf1f5b90d97e11d3377756c054459ff4.tar.zst ferdium-app-ad2e5caacf1f5b90d97e11d3377756c054459ff4.zip |
Align README with upstream
Fixes the confusion that led to https://github.com/kytwb/ferdi/issues/20
-rw-r--r-- | README.md | 77 |
1 files changed, 35 insertions, 42 deletions
@@ -4,73 +4,66 @@ | |||
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 | ||
9 | ## Installation | 12 | ## Download Ferdi |
10 | 13 | ||
11 | For macOS: | 14 | You can find the installers in the [latest release](https://github.com/kytwb/ferdi/releases) assets. |
12 | 15 | ||
13 | ``` | 16 | ### Or use homebrew (macOS only) |
14 | brew cask install ferdi | ||
15 | ``` | ||
16 | 17 | ||
17 | Alternatively, and for Linux/Windows, you can find the installers in the [latest release](https://github.com/kytwb/ferdi/releases) assets. | 18 | `$ brew cask install franz` |
19 | |||
20 | (Don't know homebrew? [brew.sh](https://brew.sh/)) | ||
18 | 21 | ||
19 | ## Features | 22 | ## Features |
20 | - [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 |
21 | - [x] Removes pages begging you to donate after registration | 24 | - [x] Removes pages begging you to donate after registration |
22 | - [x] Makes all users Premium by default | 25 | - [x] Makes all users Premium by default |
23 | - [x] [Add option to change server to a custom](#servers) [ferdi-server](https://github.com/vantezzen/ferdi-server) | 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) |
24 | - [x] Remove "Franz is better together" popup | 27 | - [x] Remove "Franz is better together" popup |
25 | - [x] [Makes it possible to edit the "Franz Todo" server](#franz-todo) | 28 | - [x] [Makes it possible to edit the "Franz Todo" server](https://github.com/kytwb/ferdi/wiki/Custom-Todo) |
26 | - [x] Makes RocketChat self-hosted generally available | 29 | - [x] Makes RocketChat self-hosted generally available |
27 | - [x] Comes with a custom branding proper to Ferdi | 30 | - [x] Comes with a custom branding proper to Ferdi |
28 | 31 | ||
29 | ### Servers | 32 | ## Development |
30 | 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. | ||
31 | 33 | ||
32 | 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. | 34 | ### Preparations |
33 | 35 | ||
34 | More information on how to set up a ferdi-server can be found at <https://github.com/vantezzen/ferdi-server/blob/master/README.md>. | 36 | #### Install Linux OS dependencies |
37 | [Guide: Linux distribution specific dependencies](docs/linux.md) | ||
35 | 38 | ||
36 | ### Franz Todo | 39 | #### Fix native modules to match current electron node version |
37 | 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. | 40 | ```bash |
41 | $ npm run rebuild | ||
42 | ``` | ||
38 | 43 | ||
39 | 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. | 44 | ### Install dependencies |
45 | Run the following command to install all dependencies, and link sibling modules with Franz. | ||
46 | ```bash | ||
47 | $ npx lerna bootstrap | ||
48 | ``` | ||
40 | 49 | ||
41 | ![Todoist in Franz Todo](screenshots/Ferdi-Todo.png) | 50 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. |
42 | 51 | ||
43 | ## Packaging | 52 | ### Run Ferdi Development App |
53 | Run these two commands __simultaneously__ in different console tabs. | ||
44 | 54 | ||
45 | ```bash | 55 | ```bash |
46 | $ npm install | 56 | $ npm run dev |
47 | $ npm run build | 57 | $ npm run start |
48 | ``` | 58 | ``` |
59 | Be aware that the development database will be reset regularly. | ||
49 | 60 | ||
50 | Deliverables will be available in the `./out` folder. | 61 | ## Packaging |
51 | 62 | ```bash | |
52 | ## Developing | 63 | $ npm run build |
64 | ``` | ||
53 | 65 | ||
54 | ### Preparations | 66 | Deliverables will be available in the ./out folder. |
55 | - [Install Linux dependencies](docs/linux.md) if you are developing on Linux | ||
56 | - 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) | ||
57 | |||
58 | ### Setup | ||
59 | |||
60 | 1. Fix native modules to match current electron node version | ||
61 | ``` | ||
62 | npm run rebuild | ||
63 | ``` | ||
64 | 2. Install dependencies using lerna | ||
65 | ``` | ||
66 | npx lerna bootstrap | ||
67 | ``` | ||
68 | 3. Run Ferdi Development App | ||
69 | Run these two commands *simultaneously* in different console tabs. | ||
70 | ``` | ||
71 | npm run dev | ||
72 | npm run start | ||
73 | ``` | ||
74 | 67 | ||
75 | ## Contributors ✨ | 68 | ## Contributors ✨ |
76 | 69 | ||