A first run wizard that explains the usage of Nextcloud to new users
No configuration is needed, but it is possible to prevent the wizard from opening for users by default. When disabled users can only open it from manually clicking "About" in the user menu.
This can be done by setting an app setting value:
occ config:app:set --value false firstrunwizard wizard_enabled
Make sure you have node
, npm
and make
installed on your system.
- ☁ Clone the app into the
apps
folder of your Nextcloud:git clone https://github.com/nextcloud/firstrunwizard.git
- 👩💻 Run
npm ci
to install the dependencies - 🏗 To build the Javascript after you have made changes, run
npm run build
- ✅ Enable the app through the app management of your Nextcloud
- 🎉 Partytime! Help fix some issues and review pull requests 👍
- Open the
src/hub-release.ts
file - Adjust the
version
property to reflect the new Hub release version - Adjust the
link
(e.g. blog post) - Add
releaseNotes
, this is an array of strings, for localization those are translated usingt('firstrunwizard', 'YOUR MESSAGE')
- Change the
videoAltText
for the Hub release animation if needed (alternative text for accessibility) - Adjust the
shareSubject
which is used when users share their thoughts about the release on social media - Replace
img/nextcloudHub.mp4
andimg/nextcloudHub.webm
(VP9) with updated animations - Update the current changelog version in
lib/Constants.php