From 8609845ad703508bf3ad4b123385df4b5257c6a8 Mon Sep 17 00:00:00 2001 From: Jan-Christoph Borchardt Date: Thu, 1 Nov 2018 15:16:30 +0100 Subject: [PATCH 1/9] Add front-end building documentation to readme Signed-off-by: Jan-Christoph Borchardt --- README.md | 39 ++++++++++++++++++++++++++++++++++++++- settings/README.md | 22 ---------------------- 2 files changed, 38 insertions(+), 23 deletions(-) delete mode 100644 settings/README.md diff --git a/README.md b/README.md index 313c1bf84db..b5344eb684b 100644 --- a/README.md +++ b/README.md @@ -38,13 +38,50 @@ ## Join the team :family: -### How to contribute +### How to contribute πŸ‘©πŸ’» 1. [Set up your local development environment](https://docs.nextcloud.com/server/14/developer_manual/general/devenv.html) :rocket: 2. [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue) :notebook: 3. Create a branch, a [Pull Request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue :computer: 4. Wait for it to get merged and :tada: + +### Building front-end code πŸ— + +We move more and more towards using Vue.js in the frontend, starting with Settings. For building the code on changes, use these terminal commands in the `settings` subfolder: + +``` bash +# install dependencies +make dev-setup + +# build for development +make build-js + +# build for development and watch edits +make watch-js + +# build for production with minification +make build-js-production + +# clean output files +make clean +``` + +**When making changes, also commit the compiled files!** + +We still use Handlebars templates some places in Files and Settings. We will replace these step-by-step with Vue.js, but in the meantime you need to compile them separately. + +If you don’t have Handlebars installed yet, you can do it with this terminal command: +``` +sudo npm install -g handlebars +``` + +Then inside the root folder of your local Nextcloud development installation, run this command in the terminal every time you changed a `.handlebars` file to compile it: +``` +./build/compile-handlebars-templates.sh +``` + + ### Contribution Guidelines All contributions to this repository from June, 16 2016 on are considered to be diff --git a/settings/README.md b/settings/README.md deleted file mode 100644 index 71a77309bd0..00000000000 --- a/settings/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# Settings section - -> Nextcloud settings with Vue - -## Build Setup - -``` bash -# install dependencies -make dev-setup - -# build for development -make build-js - -# build for development and watch edits -make watch-js - -# build for production with minification -make build-js-production - -# clean output files -make clean -``` From 1fedde9eb9012e4f0be21dc9e7e71dbcc41fe5eb Mon Sep 17 00:00:00 2001 From: Jan-Christoph Borchardt Date: Thu, 1 Nov 2018 15:33:40 +0100 Subject: [PATCH 2/9] Readme: adjust structure, wording, small fixes Signed-off-by: Jan-Christoph Borchardt --- README.md | 56 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 31 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index b5344eb684b..58c5ea84555 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Nextcloud Server +# Nextcloud Server ☁ [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nextcloud/server/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/server/?branch=master) [![codecov](https://codecov.io/gh/nextcloud/server/branch/master/graph/badge.svg)](https://codecov.io/gh/nextcloud/server) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/209/badge)](https://bestpractices.coreinfrastructure.org/projects/209) @@ -9,7 +9,7 @@ ![](https://github.com/nextcloud/screenshots/blob/master/files/filelist.png) -## Why is this so awesome? +## Why is this so awesome? 🀩 * :file_folder: **Access your Data** You can store your files, contacts, calendars and more on a server of your choosing. * :package: **Sync your Data** You keep your files, contacts, calendars and more synchronized amongst your devices. @@ -17,33 +17,44 @@ * :rocket: **Expandable with dozens of Apps** ...like [Calendar](https://github.com/nextcloud/calendar), [Contacts](https://github.com/nextcloud/contacts), [Mail](https://github.com/nextcloud/mail) and all those you can discover in our [App Store](https://apps.nextcloud.com) * :lock: **Security** with our encryption mechanisms, [HackerOne bounty program](https://hackerone.com/nextcloud) and two-factor authentication. -*You want to learn more about how you can use Nextcloud to access, share and protect your files, calendars, contacts, communication & more at home and at your Enterprise?* [**Learn about all our Features**](https://nextcloud.com/features). +You want to learn more about how you can use Nextcloud to access, share and protect your files, calendars, contacts, communication & more at home and at your Enterprise? [**Learn about all our Features**](https://nextcloud.com/features). -## Get your Nextcloud +## Get your Nextcloud 🚚 - [**Install** a server by yourself on your own hardware or by using one of our ready to use **Appliances**](https://nextcloud.com/install/#instructions-server) - [Buy one of the awesome **devices** coming with a preinstalled Nextcloud](https://nextcloud.com/devices/) - [Find a service **provider** who is hosting Nextcloud for you or your company](https://nextcloud.com/providers/) -*Enterprise? Public Sector or Education user? You may want to have a look into the [**Enterprise Support Subscription**](https://nextcloud.com/enterprise/) provided by the Nextcloud GmbH* +Enterprise? Public Sector or Education user? You may want to have a look into the [**Enterprise Support Subscription**](https://nextcloud.com/enterprise/) provided by the Nextcloud GmbH. -## Get in touch +## Get in touch πŸ’¬ * :clipboard: [Forum](https://help.nextcloud.com) * :busts_in_silhouette: [Facebook](https://facebook.com/nextclouders) * :hatching_chick: [Twitter](https://twitter.com/Nextclouders) * :elephant: [Mastodon](https://mastodon.xyz/@nextcloud) -[…learn more about how to get support for Nextcloud here!](https://nextcloud.com/support) +You can also [get support for Nextcloud](https://nextcloud.com/support)! + ## Join the team :family: -### How to contribute πŸ‘©πŸ’» +### How to contribute πŸ‘©β€πŸ’» 1. [Set up your local development environment](https://docs.nextcloud.com/server/14/developer_manual/general/devenv.html) :rocket: 2. [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue) :notebook: -3. Create a branch, a [Pull Request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue :computer: -4. Wait for it to get merged and :tada: +3. Create a branch, a [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue to review :computer: +4. Fix things that come up during review πŸ‘ +5. Wait for it to get merged! :tada: + + +### Development setup πŸ’» + +Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking `git submodule update --init` or a similar command is needed, for details see Git documentation. + +Several apps that are included by default in regular releases such as [First run wizard](https://github.com/nextcloud/firstrunwizard) or [Activity](https://github.com/nextcloud/activity) are missing in `master` and have to be installed manually by cloning them into the `apps` subfolder. + +Otherwise, git checkouts can be handled the same as release archives, by using the `stable*` branches. Note they should never be used on production systems. ### Building front-end code πŸ— @@ -82,7 +93,16 @@ Then inside the root folder of your local Nextcloud development installation, ru ``` -### Contribution Guidelines +### Tools we use πŸ›  + +[![BrowserStack](https://user-images.githubusercontent.com/45821/41675934-61fa3442-74c4-11e8-8c8e-90768c56ba08.png)](https://www.browserstack.com/) +[![WAVE](https://wave.webaim.org/img/wavelogo.png)](https://wave.webaim.org/extension/) +[![](https://developers.google.com/web/tools/lighthouse/images/lighthouse-icon-128.png) Lighthouse](https://developers.google.com/web/tools/lighthouse/) +[![axe](https://aa0q1c6q9h-flywheel.netdna-ssl.com/wp-content/uploads/2016/12/aXe-300x280.png)](https://www.deque.com/axe/) + + + +## Contribution guidelines πŸ“œ All contributions to this repository from June, 16 2016 on are considered to be licensed under the AGPLv3 or any later version. @@ -101,17 +121,3 @@ Please read the [Code of Conduct](https://nextcloud.com/community/code-of-conduc Please review the [guidelines for contributing](.github/CONTRIBUTING.md) to this repository. More information how to contribute: [https://nextcloud.com/contribute/](https://nextcloud.com/contribute/) - -### Running master checkouts - -Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking `git submodule update --init` or a similar command is needed, for details see Git documentation. - -Several apps that are included by default in regular releases such as [firstrunwizard](https://github.com/nextcloud/firstrunwizard) or [gallery](https://github.com/nextcloud/gallery) are missing in `master` and have to be installed manually. - -That aside Git checkouts can be handled the same as release archives. - -Note they should never be used on production systems. - -## Tools we use - -[![BrowserStack](https://user-images.githubusercontent.com/45821/41675934-61fa3442-74c4-11e8-8c8e-90768c56ba08.png)](https://www.browserstack.com/) From 02310b3992780b2a5cc7f394f8d6a12b5dae588c Mon Sep 17 00:00:00 2001 From: Jan-Christoph Borchardt Date: Thu, 1 Nov 2018 15:44:28 +0100 Subject: [PATCH 3/9] Readme: Fix screenshot link Signed-off-by: Jan-Christoph Borchardt --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 58c5ea84555..e36c030b8d3 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ **A safe home for all your data.** -![](https://github.com/nextcloud/screenshots/blob/master/files/filelist.png) +![](https://raw.githubusercontent.com/nextcloud/screenshots/master/files/Files%20Sharing.png) ## Why is this so awesome? 🀩 From b392d3bdc4a419da4da50e085d860733ae85eca5 Mon Sep 17 00:00:00 2001 From: Jan-Christoph Borchardt Date: Thu, 1 Nov 2018 15:47:49 +0100 Subject: [PATCH 4/9] Add sentence about non-technical contributions Signed-off-by: Jan-Christoph Borchardt --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e36c030b8d3..1099d4bf5ac 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,10 @@ You can also [get support for Nextcloud](https://nextcloud.com/support)! ## Join the team :family: -### How to contribute πŸ‘©β€πŸ’» +There are many ways to contribute, of which development is only one! Find out [how to get involved](https://nextcloud.com/contribute/), including as translator, designer, tester, helping others and much more! 😍 + + +### Development setup πŸ‘©β€πŸ’» 1. [Set up your local development environment](https://docs.nextcloud.com/server/14/developer_manual/general/devenv.html) :rocket: 2. [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue) :notebook: @@ -47,9 +50,6 @@ You can also [get support for Nextcloud](https://nextcloud.com/support)! 4. Fix things that come up during review πŸ‘ 5. Wait for it to get merged! :tada: - -### Development setup πŸ’» - Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking `git submodule update --init` or a similar command is needed, for details see Git documentation. Several apps that are included by default in regular releases such as [First run wizard](https://github.com/nextcloud/firstrunwizard) or [Activity](https://github.com/nextcloud/activity) are missing in `master` and have to be installed manually by cloning them into the `apps` subfolder. From a7b1decfe1b341f2890b421992dd6c224d6f51b7 Mon Sep 17 00:00:00 2001 From: Jan-Christoph Borchardt Date: Thu, 1 Nov 2018 15:53:00 +0100 Subject: [PATCH 5/9] Readme: Add note about signing off commits Signed-off-by: Jan-Christoph Borchardt --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1099d4bf5ac..ed989837101 100644 --- a/README.md +++ b/README.md @@ -46,9 +46,10 @@ There are many ways to contribute, of which development is only one! Find out [h 1. [Set up your local development environment](https://docs.nextcloud.com/server/14/developer_manual/general/devenv.html) :rocket: 2. [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue) :notebook: -3. Create a branch, a [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue to review :computer: -4. Fix things that come up during review πŸ‘ -5. Wait for it to get merged! :tada: +3. Create a branch and make your changes. Remember to sign off your commits using `git commit -**s**m "Your commit message"` +4. Create a [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue to review :computer: +5. Fix things that come up during review πŸ‘ +6. Wait for it to get merged! :tada: Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking `git submodule update --init` or a similar command is needed, for details see Git documentation. From 2e23404ee96ef4515e1e2dc2904fe79beb2d9d20 Mon Sep 17 00:00:00 2001 From: Jan-Christoph Borchardt Date: Thu, 1 Nov 2018 16:06:05 +0100 Subject: [PATCH 6/9] Readme: Replace Github emoji codes with real emoji Signed-off-by: Jan-Christoph Borchardt --- README.md | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index ed989837101..b046afdad5b 100644 --- a/README.md +++ b/README.md @@ -11,45 +11,46 @@ ## Why is this so awesome? 🀩 -* :file_folder: **Access your Data** You can store your files, contacts, calendars and more on a server of your choosing. -* :package: **Sync your Data** You keep your files, contacts, calendars and more synchronized amongst your devices. -* :arrows_counterclockwise: **Share your Data** …by giving others access to the stuff you want them to see or to collaborate with. -* :rocket: **Expandable with dozens of Apps** ...like [Calendar](https://github.com/nextcloud/calendar), [Contacts](https://github.com/nextcloud/contacts), [Mail](https://github.com/nextcloud/mail) and all those you can discover in our [App Store](https://apps.nextcloud.com) -* :lock: **Security** with our encryption mechanisms, [HackerOne bounty program](https://hackerone.com/nextcloud) and two-factor authentication. +* πŸ“ **Access your Data** You can store your files, contacts, calendars and more on a server of your choosing. +* πŸ”„ **Sync your Data** You keep your files, contacts, calendars and more synchronized amongst your devices. +* πŸ™Œ **Share your Data** …by giving others access to the stuff you want them to see or to collaborate with. +* πŸš€ **Expandable with dozens of Apps** ...like [Calendar](https://github.com/nextcloud/calendar), [Contacts](https://github.com/nextcloud/contacts), [Mail](https://github.com/nextcloud/mail) and all those you can discover in our [App Store](https://apps.nextcloud.com) +* πŸ”’ **Security** with our encryption mechanisms, [HackerOne bounty program](https://hackerone.com/nextcloud) and two-factor authentication. You want to learn more about how you can use Nextcloud to access, share and protect your files, calendars, contacts, communication & more at home and at your Enterprise? [**Learn about all our Features**](https://nextcloud.com/features). ## Get your Nextcloud 🚚 -- [**Install** a server by yourself on your own hardware or by using one of our ready to use **Appliances**](https://nextcloud.com/install/#instructions-server) -- [Buy one of the awesome **devices** coming with a preinstalled Nextcloud](https://nextcloud.com/devices/) -- [Find a service **provider** who is hosting Nextcloud for you or your company](https://nextcloud.com/providers/) +- β˜‘οΈ [**Simply sign up**](https://nextcloud.com/signup/) either through our website or through the apps directly. +- πŸ–₯ [**Install** a server by yourself](https://nextcloud.com/install/#instructions-server) on your own hardware or by using one of our ready to use **appliances** +- πŸ“¦ Buy one of the [awesome **devices** coming with a preinstalled Nextcloud](https://nextcloud.com/devices/) +- 🏒 Find a [service **provider**](https://nextcloud.com/providers/) who hosts Nextcloud for you or your company Enterprise? Public Sector or Education user? You may want to have a look into the [**Enterprise Support Subscription**](https://nextcloud.com/enterprise/) provided by the Nextcloud GmbH. ## Get in touch πŸ’¬ -* :clipboard: [Forum](https://help.nextcloud.com) -* :busts_in_silhouette: [Facebook](https://facebook.com/nextclouders) -* :hatching_chick: [Twitter](https://twitter.com/Nextclouders) -* :elephant: [Mastodon](https://mastodon.xyz/@nextcloud) +* [πŸ“‹ Forum](https://help.nextcloud.com) +* [πŸ‘₯ Facebook](https://facebook.com/nextclouders) +* [🐣 Twitter](https://twitter.com/Nextclouders) +* [🐘 Mastodon](https://mastodon.xyz/@nextcloud) You can also [get support for Nextcloud](https://nextcloud.com/support)! -## Join the team :family: +## Join the team πŸ‘ͺ There are many ways to contribute, of which development is only one! Find out [how to get involved](https://nextcloud.com/contribute/), including as translator, designer, tester, helping others and much more! 😍 ### Development setup πŸ‘©β€πŸ’» -1. [Set up your local development environment](https://docs.nextcloud.com/server/14/developer_manual/general/devenv.html) :rocket: -2. [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue) :notebook: -3. Create a branch and make your changes. Remember to sign off your commits using `git commit -**s**m "Your commit message"` -4. Create a [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue to review :computer: -5. Fix things that come up during review πŸ‘ -6. Wait for it to get merged! :tada: +1. πŸš€ [Set up your local development environment](https://docs.nextcloud.com/server/14/developer_manual/general/devenv.html) +2. πŸ› [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue) +3. πŸ‘©β€πŸ”§ Create a branch and make your changes. Remember to sign off your commits using `git commit -**s**m "Your commit message"` +4. ⬆ Create a [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue to review +5. πŸ‘ Fix things that come up during review +6. πŸŽ‰ Wait for it to get merged! Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking `git submodule update --init` or a similar command is needed, for details see Git documentation. From f946ad71f7826b9beb143de740264a050c65d4a9 Mon Sep 17 00:00:00 2001 From: Jan-Christoph Borchardt Date: Thu, 1 Nov 2018 16:17:43 +0100 Subject: [PATCH 7/9] Readme: Add line breaks between tool images Signed-off-by: Jan-Christoph Borchardt --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b046afdad5b..c0f081b5e68 100644 --- a/README.md +++ b/README.md @@ -98,8 +98,12 @@ Then inside the root folder of your local Nextcloud development installation, ru ### Tools we use πŸ›  [![BrowserStack](https://user-images.githubusercontent.com/45821/41675934-61fa3442-74c4-11e8-8c8e-90768c56ba08.png)](https://www.browserstack.com/) + [![WAVE](https://wave.webaim.org/img/wavelogo.png)](https://wave.webaim.org/extension/) -[![](https://developers.google.com/web/tools/lighthouse/images/lighthouse-icon-128.png) Lighthouse](https://developers.google.com/web/tools/lighthouse/) + +[![](https://developers.google.com/web/tools/lighthouse/images/lighthouse-icon-128.png) +Lighthouse](https://developers.google.com/web/tools/lighthouse/) + [![axe](https://aa0q1c6q9h-flywheel.netdna-ssl.com/wp-content/uploads/2016/12/aXe-300x280.png)](https://www.deque.com/axe/) From 4986ca85c93f31adade37dedf8c10261fa886987 Mon Sep 17 00:00:00 2001 From: Jan-Christoph Borchardt Date: Thu, 1 Nov 2018 16:27:56 +0100 Subject: [PATCH 8/9] Readme: Reduce size of Tools logos, use HTML for part Signed-off-by: Jan-Christoph Borchardt --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c0f081b5e68..4cd9783650e 100644 --- a/README.md +++ b/README.md @@ -97,14 +97,18 @@ Then inside the root folder of your local Nextcloud development installation, ru ### Tools we use πŸ›  -[![BrowserStack](https://user-images.githubusercontent.com/45821/41675934-61fa3442-74c4-11e8-8c8e-90768c56ba08.png)](https://www.browserstack.com/) - -[![WAVE](https://wave.webaim.org/img/wavelogo.png)](https://wave.webaim.org/extension/) - -[![](https://developers.google.com/web/tools/lighthouse/images/lighthouse-icon-128.png) -Lighthouse](https://developers.google.com/web/tools/lighthouse/) - -[![axe](https://aa0q1c6q9h-flywheel.netdna-ssl.com/wp-content/uploads/2016/12/aXe-300x280.png)](https://www.deque.com/axe/) + + BrowserStack + + + WAVE + + + Lighthouse + + + axe + From 713534da2c033ffc1c30f71b63cabd5d3fd7d16d Mon Sep 17 00:00:00 2001 From: Jan-Christoph Borchardt Date: Thu, 1 Nov 2018 16:38:40 +0100 Subject: [PATCH 9/9] Readme: Simply use emojis instead of images for tools section Signed-off-by: Jan-Christoph Borchardt --- README.md | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 4cd9783650e..37fbe567100 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ There are many ways to contribute, of which development is only one! Find out [h 1. πŸš€ [Set up your local development environment](https://docs.nextcloud.com/server/14/developer_manual/general/devenv.html) 2. πŸ› [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue) -3. πŸ‘©β€πŸ”§ Create a branch and make your changes. Remember to sign off your commits using `git commit -**s**m "Your commit message"` +3. πŸ‘©β€πŸ”§ Create a branch and make your changes. Remember to sign off your commits using `git commit -sm "Your commit message"` 4. ⬆ Create a [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue to review 5. πŸ‘ Fix things that come up during review 6. πŸŽ‰ Wait for it to get merged! @@ -97,19 +97,9 @@ Then inside the root folder of your local Nextcloud development installation, ru ### Tools we use πŸ›  - - BrowserStack - - - WAVE - - - Lighthouse - - - axe - - +- [πŸ‘€ BrowserStack](https://browserstack.com) for cross-browser testing +- [🌊 WAVE](https://wave.webaim.org/extension/) for accessibility testing +- [🚨 Lighthouse](https://developers.google.com/web/tools/lighthouse/) for testing of performance, accessibility and more ## Contribution guidelines πŸ“œ