diff options
| -rw-r--r-- | README.md | 39 | ||||
| -rw-r--r-- | settings/README.md | 22 |
2 files changed, 38 insertions, 23 deletions
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 -``` |