From 51f6e005d9641b2e1ee6fe2ae1323dc4a329fe6e Mon Sep 17 00:00:00 2001 From: Amine Mouafik Date: Tue, 24 Sep 2019 22:08:40 +0700 Subject: #73 Give visibility to Ferdi's OpenCollective --- .github/FUNDING.yml | 1 + .github/ISSUE_TEMPLATE/bug_report.md | 21 +++++++++++++-------- .github/ISSUE_TEMPLATE/feature_request.md | 4 +++- README.md | 22 +++++++++++++++++----- 4 files changed, 34 insertions(+), 14 deletions(-) create mode 100644 .github/FUNDING.yml 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 @@ --- name: Bug report about: Create a report to help us improve - --- **Describe the bug** @@ -9,6 +8,7 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' @@ -21,15 +21,20 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. **Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] **Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] + +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] **Additional context** Add any other context about the problem here. + + 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 @@ --- name: Feature request about: Suggest an idea for this project - --- **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 **Additional context** Add any other context or screenshots about the feature request here. + + diff --git a/README.md b/README.md index e1f2826fb..65a6aca67 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@

-# Ferdi +# Ferdi -[![Build Status Windows](https://ci.appveyor.com/api/projects/status/2ckfbmoxp36fye5b?svg=true)](https://ci.appveyor.com/project/kytwb/ferdi) - [![Build Status Mac & Linux](https://travis-ci.org/getferdi/ferdi.svg?branch=master)](https://travis-ci.org/getferdi/ferdi) +[![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) +[![Build Status Mac & Linux](https://travis-ci.org/getferdi/ferdi.svg?branch=master)](https://travis-ci.org/getferdi/ferdi) 🤴🏽 Hard-fork of [Franz](https://github.com/meetfranz/franz), adding awesome features and removing unwanted ones. @@ -20,6 +20,7 @@ You can find the installers in the [latest release](https://github.com/getferdi/ (Don't know homebrew? [brew.sh](https://brew.sh/)) ## Ferdi-specific Features + - [x] Removes the counter-productive fullscreen app delay inviting users to upgrade - [x] Removes pages begging you to donate after registration - [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/ ### Preparations #### Install Linux OS dependencies + [Guide: Linux distribution specific dependencies](docs/linux.md) #### Use right NodeJS version + 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) #### Fix native modules to match current electron node version + ```bash $ npm run rebuild ``` ### Install dependencies + Run the following command to install all dependencies, and link sibling modules with Franz. + ```bash $ npx lerna bootstrap ``` -If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. +If you previously ran `npm install` it sometimes is necessary to delete your `node_modules` folder before running `npx lerna bootstrap`. ### Run Ferdi Development App -Run these two commands __simultaneously__ in different console tabs. + +Run these two commands **simultaneously** in different console tabs. ```bash $ npm run dev $ npm run start ``` + Be aware that the development database will be reset regularly. ## Packaging + ```bash $ npm run build ``` @@ -81,6 +90,7 @@ Deliverables will be available in the ./out folder. ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + @@ -105,6 +115,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d + @@ -112,6 +123,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d + This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! -- cgit v1.2.3-54-g00ecf