side_menu/README.md

61 lines
1.9 KiB
Markdown
Raw Normal View History

2020-09-23 13:17:13 +02:00
🤙 Nextcloud app / Custom menu 🎨
2020-03-28 21:00:06 +01:00
===============================
2020-09-23 13:17:13 +02:00
Allows you to modify the position of the main menu by creating a panel on the left of the interface or with a big menu on the top.
2020-08-13 16:51:41 +02:00
You can also define apps that must be displayed in the top menu. Fully customisable.
2020-04-22 00:42:47 +02:00
This application is rather suitable for instances that activate a lot of applications.
2020-03-28 20:51:49 +01:00
Comptatible with AppOrder.
2020-05-14 17:03:09 +02:00
* [Installation and upgrade](#installation-and-upgrade)
2020-05-14 17:02:23 +02:00
* [How to contribute?](#how-to-contribute)
2020-09-03 10:11:09 +02:00
* [Screenshots](https://gitnet.fr/deblan/side_menu/src/branch/master/screenshots/)
2020-03-30 10:44:46 +02:00
2020-11-06 18:17:17 +01:00
You like this app and you want to support me? ☕ [Buy me a coffee](https://www.buymeacoffee.com/deblan) or [Donate with liberapay](https://liberapay.com/deblan)
2020-09-11 13:46:25 +02:00
2020-10-24 14:29:32 +02:00
Requirements
------------
* PHP >= 7.3
* App `theming` enabled
Installation and upgrade
------------------------
2020-04-09 10:52:58 +02:00
2020-10-16 13:42:23 +02:00
Custom menu is available from the app store.
```
$ cd /path/to/nextcloud
$ php occ app:install side_menu
```
If you want to install it from source, go to https://gitnet.fr/deblan/side_menu/releases and copy the link to the last release (side_menu_vX.Y.Z.tar.gz). Then:
2020-03-30 10:44:46 +02:00
```
$ cd /path/to/nextcloud/apps
2020-10-16 13:42:23 +02:00
$ curl -sS https://gitnet.fr/attachments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | tar xvfz -
2020-03-30 10:44:46 +02:00
```
2020-05-11 22:57:55 +02:00
Administrators can edit many settings using the administration page.
Users can disable the menu using the page of personal settings.
2020-04-09 14:33:35 +02:00
Use the shortcut `Ctrl`+`o` to open and to hide the side menu. Use `tab` to navigate.
2020-04-09 14:33:35 +02:00
How to contribute?
------------------
2020-04-22 00:42:47 +02:00
You can report a bug or request a feature by opening an issue: https://gitnet.fr/deblan/side_menu/issues
If you are a developer:
* fork the repository
* install an instance of Nextcloud
* go to `apps/` and clone your repository
* go to `apps/side_menu` and run `npm install`
2020-04-09 14:33:35 +02:00
2020-08-29 14:04:52 +02:00
Build javascripts using `make npm-build` (or `make npm-watch` to build them in real time).
2020-04-09 14:33:35 +02:00
Then commit and create a pull request.