aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Amine Mouafik <amine@mouafik.fr>2019-09-24 22:08:40 +0700
committerLibravatar Amine Mouafik <amine@mouafik.fr>2019-09-24 22:08:40 +0700
commit51f6e005d9641b2e1ee6fe2ae1323dc4a329fe6e (patch)
treeafee42071c27c315fb374d0b3817435096b7fb5f /README.md
parent5.3.4-beta.3 (diff)
downloadferdium-app-51f6e005d9641b2e1ee6fe2ae1323dc4a329fe6e.tar.gz
ferdium-app-51f6e005d9641b2e1ee6fe2ae1323dc4a329fe6e.tar.zst
ferdium-app-51f6e005d9641b2e1ee6fe2ae1323dc4a329fe6e.zip
#73 Give visibility to Ferdi's OpenCollective
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.md b/README.md
index e1f2826fb..65a6aca67 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,10 @@
2 <img src="./build-helpers/images/icon.png" alt="" width="200"/> 2 <img src="./build-helpers/images/icon.png" alt="" width="200"/>
3</p> 3</p>
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) 7[![Backers on Open Collective](https://opencollective.com/getferdi/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/getferdi/sponsors/badge.svg)](#sponsors) [![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/getferdi/ferdi.svg?branch=master)](https://travis-ci.org/getferdi/ferdi) 8[![Build Status Mac & Linux](https://travis-ci.org/getferdi/ferdi.svg?branch=master)](https://travis-ci.org/getferdi/ferdi)
9 9
10🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones. 10🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones.
11 11
@@ -20,6 +20,7 @@ You can find the installers in the [latest release](https://github.com/getferdi/
20(Don't know homebrew? [brew.sh](https://brew.sh/)) 20(Don't know homebrew? [brew.sh](https://brew.sh/))
21 21
22## Ferdi-specific Features 22## Ferdi-specific Features
23
23- [x] Removes the counter-productive fullscreen app delay inviting users to upgrade 24- [x] Removes the counter-productive fullscreen app delay inviting users to upgrade
24- [x] Removes pages begging you to donate after registration 25- [x] Removes pages begging you to donate after registration
25- [x] Makes all users Premium by default ([#15](https://github.com/getferdi/ferdi/issues/15)) 26- [x] Makes all users Premium by default ([#15](https://github.com/getferdi/ferdi/issues/15))
@@ -44,34 +45,42 @@ You can find the installers in the [latest release](https://github.com/getferdi/
44### Preparations 45### Preparations
45 46
46#### Install Linux OS dependencies 47#### Install Linux OS dependencies
48
47[Guide: Linux distribution specific dependencies](docs/linux.md) 49[Guide: Linux distribution specific dependencies](docs/linux.md)
48 50
49#### Use right NodeJS version 51#### Use right NodeJS version
52
50Please make sure you are running NodeJS v10 (v10.16.3 suggested). Versions above will throw an errow when trying to install due to an [old fsevent dependency](https://github.com/fsevents/fsevents/issues/278) 53Please make sure you are running NodeJS v10 (v10.16.3 suggested). Versions above will throw an errow when trying to install due to an [old fsevent dependency](https://github.com/fsevents/fsevents/issues/278)
51 54
52#### Fix native modules to match current electron node version 55#### Fix native modules to match current electron node version
56
53```bash 57```bash
54$ npm run rebuild 58$ npm run rebuild
55``` 59```
56 60
57### Install dependencies 61### Install dependencies
62
58Run the following command to install all dependencies, and link sibling modules with Franz. 63Run the following command to install all dependencies, and link sibling modules with Franz.
64
59```bash 65```bash
60$ npx lerna bootstrap 66$ npx lerna bootstrap
61``` 67```
62 68
63If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. 69If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`.
64 70
65### Run Ferdi Development App 71### Run Ferdi Development App
66Run these two commands __simultaneously__ in different console tabs. 72
73Run these two commands **simultaneously** in different console tabs.
67 74
68```bash 75```bash
69$ npm run dev 76$ npm run dev
70$ npm run start 77$ npm run start
71``` 78```
79
72Be aware that the development database will be reset regularly. 80Be aware that the development database will be reset regularly.
73 81
74## Packaging 82## Packaging
83
75```bash 84```bash
76$ npm run build 85$ npm run build
77``` 86```
@@ -81,6 +90,7 @@ Deliverables will be available in the ./out folder.
81## Contributors ✨ 90## Contributors ✨
82 91
83Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): 92Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
93
84<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> 94<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
85<!-- prettier-ignore-start --> 95<!-- prettier-ignore-start -->
86<!-- markdownlint-disable --> 96<!-- markdownlint-disable -->
@@ -105,6 +115,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
105 115
106<!-- markdownlint-enable --> 116<!-- markdownlint-enable -->
107<!-- prettier-ignore-end --> 117<!-- prettier-ignore-end -->
118
108<!-- ALL-CONTRIBUTORS-LIST:END --> 119<!-- ALL-CONTRIBUTORS-LIST:END -->
109 120
110<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> 121<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
@@ -112,6 +123,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
112<!-- markdownlint-disable --> 123<!-- markdownlint-disable -->
113<!-- markdownlint-enable --> 124<!-- markdownlint-enable -->
114<!-- prettier-ignore-end --> 125<!-- prettier-ignore-end -->
126
115<!-- ALL-CONTRIBUTORS-LIST:END --> 127<!-- ALL-CONTRIBUTORS-LIST:END -->
116 128
117This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! 129This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!