Installation

Installation

On Frappe Cloud

Open your site in the Frappe Cloud dashboard, choose Apps → Install App, and pick Nexus Theme from the Marketplace. Nothing else to do.

Which version do I need?

There is one branch per framework version. Run bench version first and read the frappe line.

Your bench	Branch to install	Install with
Frappe / ERPNext 16	version-16	bench get-app --branch version-16 https://github.com/abbas0444/nexus_theme.git
Frappe / ERPNext 15	version-15	bench get-app --branch version-15 https://github.com/abbas0444/nexus_theme.git

There are only these two branches, and version-16 is the repository's default, so leaving --branch out also gets you the 16 build. Both hold the same features; they differ only where the two frameworks differ. Installing the wrong one damages nothing, but the app will not work properly — switch branches and migrate again.

On Frappe Cloud you never choose a branch: the Marketplace listing installs the one that matches your site.

On your own bench

Run these commands. Replace yoursite.com with your site name, and use the branch from the table above.

cd /path/to/your/bench
bench get-app --branch version-16 https://github.com/abbas0444/nexus_theme.git
bench --site yoursite.com install-app nexus_theme
bench --site yoursite.com migrate
bench restart          # or restart `bench start` in development

What installation does for you

• Creates the Theme User role and gives it to every Desk user, so Theme Studio and Sound Studio work at once. New Desk users get the role automatically when they are created or promoted.
• Loads the 17 bundled themes.
• Creates the Theme Settings record with every option switched off, so the app changes nothing about your site until you decide.
• Adds Theme Studio and Sound Settings to the avatar menu, the Nexus Theme tile to the apps screen, and the Nexus Theme workspace with all its shortcuts.
• Registers the Permission Inspector page for System Managers.

Updating

Run the usual update, then migrate and restart:

bench update                      # or: cd apps/nexus_theme && git pull
bench --site yoursite.com migrate
bench restart

Your custom themes and sound choices survive updates. New bundled themes never overwrite your own.

The restart matters after an update that renames a page: Frappe keeps the Desk's module sidebar in the web server's memory until the server restarts. Frappe Cloud restarts for you.

Uninstalling

bench --site yoursite.com uninstall-app nexus_theme

This removes the Theme User role, the menu items, the tile and the app's own tables. It never touches Frappe's own permission records: everything the Permission Inspector changed stays exactly as Frappe's Role Permission Manager would have left it.

Requirements

Needs	Version
Frappe / ERPNext	16
Python	Whatever your Frappe 16 bench requires (3.14 or newer)
Database	MariaDB with InnoDB
Browser	Any modern browser with audio support