diff options
| -rw-r--r-- | README.md | 125 | ||||
| -rw-r--r-- | settings/README.md | 22 |
2 files changed, 84 insertions, 63 deletions
diff --git a/README.md b/README.md index 313c1bf84db..37fbe567100 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Nextcloud Server +# Nextcloud Server β [](https://scrutinizer-ci.com/g/nextcloud/server/?branch=master) [](https://codecov.io/gh/nextcloud/server) [](https://bestpractices.coreinfrastructure.org/projects/209) @@ -7,45 +7,102 @@ **A safe home for all your data.** - + -## 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. -* :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). +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/) +- βοΈ [**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* +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) +* [π Forum](https://help.nextcloud.com) +* [π₯ Facebook](https://facebook.com/nextclouders) +* [π£ Twitter](https://twitter.com/Nextclouders) +* [π 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 +## Join the team πͺ -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: +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! π -### Contribution Guidelines + +### Development setup π©βπ» + +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 -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! + +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 π + +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 +``` + + +### Tools we use π + +- [π 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 π All contributions to this repository from June, 16 2016 on are considered to be licensed under the AGPLv3 or any later version. @@ -64,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 - -[](https://www.browserstack.com/) 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 -``` |