# Intros

An app that runs [intro.js](https://introjs.com/) tutorials in Nextcloud apps for new users.

## Installation

> This app is now available on the [nextcloud app store](https://apps.nextcloud.com/apps/intros). You can download it from there or install it from the apps section in your Nextcloud.

### Dev installation

Clone this repo in the `apps` directory of your dev environment.

Install the dependencies and build the frontend files:

```
npm install
npm run dev
```

Finally, enable the app in the Apps section in Nextcloud.

### Admin

This app implements [intro.js](https://introjs.com/) into Nextcloud. 

The app comes with pre-bundled tutorials for the following apps:

- Dashboard
- Files
- Contacts
- Calendar
- Talk
- User settings
- Element
- Passwords

If you want something more custom, you can define your own tutorials in json files. Find some examples in the [examples](./examples/) folder, and details on the files syntax in the [documentation](./DOCS.md).

### User

The tutorials will be shown to the users automatically on their first visit.

Users can enable or disable the tutorial of each app in the user settings menu.
