diff options
author | Amine Mouafik <amine@mouafik.fr> | 2019-09-24 22:08:40 +0700 |
---|---|---|
committer | Amine Mouafik <amine@mouafik.fr> | 2019-09-24 22:08:40 +0700 |
commit | 51f6e005d9641b2e1ee6fe2ae1323dc4a329fe6e (patch) | |
tree | afee42071c27c315fb374d0b3817435096b7fb5f | |
parent | 5.3.4-beta.3 (diff) | |
download | ferdium-app-51f6e005d9641b2e1ee6fe2ae1323dc4a329fe6e.tar.gz ferdium-app-51f6e005d9641b2e1ee6fe2ae1323dc4a329fe6e.tar.zst ferdium-app-51f6e005d9641b2e1ee6fe2ae1323dc4a329fe6e.zip |
#73 Give visibility to Ferdi's OpenCollective
-rw-r--r-- | .github/FUNDING.yml | 1 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 21 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 4 | ||||
-rw-r--r-- | README.md | 22 |
4 files changed, 34 insertions, 14 deletions
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 000000000..5200e7101 --- /dev/null +++ b/.github/FUNDING.yml | |||
@@ -0,0 +1 @@ | |||
open_collective: getferdi | |||
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b73537336..9792c40be 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md | |||
@@ -1,7 +1,6 @@ | |||
1 | --- | 1 | --- |
2 | name: Bug report | 2 | name: Bug report |
3 | about: Create a report to help us improve | 3 | about: Create a report to help us improve |
4 | |||
5 | --- | 4 | --- |
6 | 5 | ||
7 | **Describe the bug** | 6 | **Describe the bug** |
@@ -9,6 +8,7 @@ A clear and concise description of what the bug is. | |||
9 | 8 | ||
10 | **To Reproduce** | 9 | **To Reproduce** |
11 | Steps to reproduce the behavior: | 10 | Steps to reproduce the behavior: |
11 | |||
12 | 1. Go to '...' | 12 | 1. Go to '...' |
13 | 2. Click on '....' | 13 | 2. Click on '....' |
14 | 3. Scroll down to '....' | 14 | 3. Scroll down to '....' |
@@ -21,15 +21,20 @@ A clear and concise description of what you expected to happen. | |||
21 | If applicable, add screenshots to help explain your problem. | 21 | If applicable, add screenshots to help explain your problem. |
22 | 22 | ||
23 | **Desktop (please complete the following information):** | 23 | **Desktop (please complete the following information):** |
24 | - OS: [e.g. iOS] | 24 | |
25 | - Browser [e.g. chrome, safari] | 25 | - OS: [e.g. iOS] |
26 | - Version [e.g. 22] | 26 | - Browser [e.g. chrome, safari] |
27 | - Version [e.g. 22] | ||
27 | 28 | ||
28 | **Smartphone (please complete the following information):** | 29 | **Smartphone (please complete the following information):** |
29 | - Device: [e.g. iPhone6] | 30 | |
30 | - OS: [e.g. iOS8.1] | 31 | - Device: [e.g. iPhone6] |
31 | - Browser [e.g. stock browser, safari] | 32 | - OS: [e.g. iOS8.1] |
32 | - Version [e.g. 22] | 33 | - Browser [e.g. stock browser, safari] |
34 | - Version [e.g. 22] | ||
33 | 35 | ||
34 | **Additional context** | 36 | **Additional context** |
35 | Add any other context about the problem here. | 37 | Add any other context about the problem here. |
38 | |||
39 | <!-- Love Ferdi? Please consider supporting our collective: | ||
40 | 👉 https://opencollective.com/getferdi/donate --> | ||
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 066b2d920..5535496d2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md | |||
@@ -1,7 +1,6 @@ | |||
1 | --- | 1 | --- |
2 | name: Feature request | 2 | name: Feature request |
3 | about: Suggest an idea for this project | 3 | about: Suggest an idea for this project |
4 | |||
5 | --- | 4 | --- |
6 | 5 | ||
7 | **Is your feature request related to a problem? Please describe.** | 6 | **Is your feature request related to a problem? Please describe.** |
@@ -15,3 +14,6 @@ A clear and concise description of any alternative solutions or features you've | |||
15 | 14 | ||
16 | **Additional context** | 15 | **Additional context** |
17 | Add any other context or screenshots about the feature request here. | 16 | Add any other context or screenshots about the feature request here. |
17 | |||
18 | <!-- Love Ferdi? Please consider supporting our collective: | ||
19 | 👉 https://opencollective.com/getferdi/donate --> | ||
@@ -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 | |||
50 | Please 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) | 53 | Please 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 | |||
58 | Run the following command to install all dependencies, and link sibling modules with Franz. | 63 | Run 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 | ||
63 | If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. | 69 | If 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 |
66 | Run these two commands __simultaneously__ in different console tabs. | 72 | |
73 | Run 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 | |||
72 | Be aware that the development database will be reset regularly. | 80 | Be 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 | ||
83 | Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | 92 | Thanks 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 | ||
117 | This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! | 129 | This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! |