diff options
author | Amine Mouafik <amine@mouafik.fr> | 2019-09-06 19:41:53 +0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-09-06 19:41:53 +0700 |
commit | 98aa1c6ccb230ef9e6342df61e11421f7bdee30d (patch) | |
tree | c5fe0d350e38782dded3a06362f848f3279a5e0c /README.md | |
parent | Update dev-app-update.yml (diff) | |
parent | Remove all-contributors badges (diff) | |
download | ferdium-app-98aa1c6ccb230ef9e6342df61e11421f7bdee30d.tar.gz ferdium-app-98aa1c6ccb230ef9e6342df61e11421f7bdee30d.tar.zst ferdium-app-98aa1c6ccb230ef9e6342df61e11421f7bdee30d.zip |
Merge pull request #17 from vantezzen/master
Remove analytics, custom server support, custom branding and more
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 78 |
1 files changed, 70 insertions, 8 deletions
@@ -1,8 +1,28 @@ | |||
1 | <img src="./build-helpers/images/icon.png" alt="" width="150"/> | 1 | <p align="center"> |
2 | <img src="./build-helpers/images/icon.png" alt="" width="200"/> | ||
3 | </p> | ||
2 | 4 | ||
3 | # Ferdi | 5 | # Ferdi |
6 | |||
7 | 👛 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted features. | ||
8 | |||
9 | ## Features | ||
10 | - [x] Removes the fullscreen app delay inviting users to upgrade | ||
11 | - [x] Removes pages begging you to donate after registration | ||
12 | - [x] Makes all users premium | ||
13 | - [x] [Add option to change server to a custom](#servers) [ferdi-server](https://github.com/vantezzen/ferdi-server) | ||
14 | - [x] Remove "Franz is better together"(shareFranz) popup | ||
15 | - [x] Custom branding | ||
16 | - [ ] [#5](https://github.com/kytwb/Ferdi/issues/5) Makes it optional to create an account | ||
17 | - [ ] [#6](https://github.com/kytwb/Ferdi/issues/6) Makes RocketChat self-hosted generally available | ||
18 | |||
19 | ## Servers | ||
20 | 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. | ||
21 | |||
22 | 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. | ||
23 | |||
24 | More information on how to set up a ferdi-server can be found at <https://github.com/vantezzen/ferdi-server/blob/master/README.md>. | ||
4 | 25 | ||
5 | 👛 Hard-fork of [Franz](https://github.com/meetfranz/franz) removing the non-skippable app delay (too) frequently inviting you to buy a licence | ||
6 | 26 | ||
7 | ## Packaging | 27 | ## Packaging |
8 | 28 | ||
@@ -13,12 +33,54 @@ $ npm run build | |||
13 | 33 | ||
14 | Deliverables will be available in the `./out` folder. | 34 | Deliverables will be available in the `./out` folder. |
15 | 35 | ||
36 | ## Developing | ||
37 | ### Preparations | ||
38 | - [Install Linux dependencies](docs/linux.md) if you are developing on Linux | ||
39 | - 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) | ||
40 | |||
41 | ### Setup | ||
42 | 1. Fix native modules to match current electron node version | ||
43 | ``` | ||
44 | npm run rebuild | ||
45 | ``` | ||
46 | 2. Install dependencies using lerna | ||
47 | ``` | ||
48 | npx lerna bootstrap | ||
49 | ``` | ||
50 | 3. Run Ferdi Development App | ||
51 | Run these two commands *simultaneously* in different console tabs. | ||
52 | ``` | ||
53 | npm run dev | ||
54 | npm run start | ||
55 | ``` | ||
56 | |||
16 | ## Releases | 57 | ## Releases |
17 | 58 | ||
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. | 59 | 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. |
19 | 60 | ||
20 | ## Features | 61 | ## Contributors ✨ |
21 | 62 | ||
22 | - [x] Removes the fullscreen app delay inviting users to upgrade | 63 | Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): |
23 | - [ ] [#5](https://github.com/kytwb/ferdi/issues/5) Makes it optional to create an account | 64 | <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> |
24 | - [ ] [#6](https://github.com/kytwb/ferdi/issues/6) Makes RocketChat self-hosted generally available | 65 | <!-- prettier-ignore-start --> |
66 | <!-- markdownlint-disable --> | ||
67 | <table> | ||
68 | <tr> | ||
69 | <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> | ||
70 | <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> | ||
71 | <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> | ||
72 | </tr> | ||
73 | </table> | ||
74 | |||
75 | <!-- markdownlint-enable --> | ||
76 | <!-- prettier-ignore-end --> | ||
77 | <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
78 | |||
79 | <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
80 | <!-- prettier-ignore-start --> | ||
81 | <!-- markdownlint-disable --> | ||
82 | <!-- markdownlint-enable --> | ||
83 | <!-- prettier-ignore-end --> | ||
84 | <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
85 | |||
86 | This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file | ||