|
|
@@ -57,80 +57,6 @@ Several apps that are included by default in regular releases such as [First run |
|
|
|
|
|
|
|
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. |
|
|
|
|
|
|
|
### Working with front-end code 🏗 |
|
|
|
|
|
|
|
#### Building Vue components and scripts |
|
|
|
|
|
|
|
We are moving more and more toward using Vue.js in the front-end, starting with Settings. For building the code on changes, use these terminal commands in the root folder: |
|
|
|
|
|
|
|
```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 |
|
|
|
``` |
|
|
|
|
|
|
|
#### Building styles |
|
|
|
|
|
|
|
Styles are written in SCSS and compiled to css. |
|
|
|
|
|
|
|
```bash |
|
|
|
# install dependencies |
|
|
|
make dev-setup |
|
|
|
|
|
|
|
# compile style sheets |
|
|
|
npm run sass |
|
|
|
|
|
|
|
# compile style sheets and watch edits |
|
|
|
npm run sass:watch |
|
|
|
``` |
|
|
|
|
|
|
|
#### Committing changes |
|
|
|
|
|
|
|
**When making changes, also commit the compiled files!** |
|
|
|
|
|
|
|
We still use Handlebars templates in 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: |
|
|
|
```bash |
|
|
|
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: |
|
|
|
```bash |
|
|
|
./build/compile-handlebars-templates.sh |
|
|
|
``` |
|
|
|
|
|
|
|
Before checking in JS changes, make sure to also build for production: |
|
|
|
```bash |
|
|
|
make build-js-production |
|
|
|
``` |
|
|
|
Then add the compiled files for committing. |
|
|
|
|
|
|
|
To save some time, to only rebuild for a specific app, use the following and replace the module with the app name: |
|
|
|
```bash |
|
|
|
MODULE=user_status make build-js-production |
|
|
|
``` |
|
|
|
|
|
|
|
Please note that if you used `make build-js` or `make watch-js` before, you'll notice that a lot of files were marked as changed, so might need to clear the workspace first. |
|
|
|
|
|
|
|
### Working with back-end code 🏗 |
|
|
|
|
|
|
|
When changing back-end PHP code, in general, no additional steps are needed before checking in. |
|
|
|
|
|
|
|
However, if new files were created, you will need to run the following command to update the autoloader files: |
|
|
|
```bash |
|
|
|
build/autoloaderchecker.sh |
|
|
|
``` |
|
|
|
|
|
|
|
After that, please also include the autoloader file changes in your commits. |
|
|
|
|
|
|
|
### Tools we use 🛠 |
|
|
|
|