796533ff11
* merge libs rollup configs to one rollup * move css from libs to src/core * run rollup on cms build * move test-utils to /utils folder * move css to src/core * mark @umbraco-cms/backoffice as external when building for CMS * rename all models to include @umbraco-cms/backoffice in their path to allow us to publish as a single module * rename all imports to @umbraco-cms/backoffice/* * rename events to umb-events to avoid rollup error of protected module name(?) * test that libs can build * move css to src/core * move umb-lit-element and modal elements to src/core * move some modal interfaces back to libs/modal * move the icon store into src/core since it is very localized to the backoffice * comment out build:libs for now since Github runs out of memory * rename to match tsconfig alias * add package.json to libs * only make libs for lib folders * turn off emit for typescript since we are handling types for libs separately * build libs locally * add script to move libs to final destination with some transform * move libs after build * move package.json to dist folder first (so we can publish from there) * remove inline comments * ensure the outputDir exists * Remove re-export of extensions-registry library from models library * move to individual files to avoid circular imports * check if outputDir exists before trying to create it * write transforms first in dist file and then copy the file to outputDir * ensure all umbraco types are external * copy information from main package.json file
Umbraco.CMS.Backoffice
Installation instructions
- Run
npm install - Run
npm run devto launch Vite in dev mode
Environment variables
The development environment supports .env files, so in order to set your own make a copy
of .env and name it .env.local and set the variables you need.
As an example to show the installer instead of the login screen, set the following
in the .env.local file to indicate that Umbraco has not been installed:
VITE_UMBRACO_INSTALL_STATUS=must-install
Environments
Development
The development environment is the default environment and is used when running npm run dev. All API calls are mocked and the Umbraco backoffice is served from the src folder.
Run against a local Umbraco instance
Create a .env.local file and set the following variables:
VITE_UMBRACO_API_URL=http://localhost:5000 # This will be the URL to your Umbraco instance
VITE_UMBRACO_USE_MSW=off # Indicate that you want all API calls to bypass MSW (mock-service-worker)
Static website
See the Main branch in action here as an Azure Static Web App. The deploy runs automatically every time the main branch is updated. It uses mocked responses from the Umbraco API to simulate the site just like the local development environment.
Storybook
Storybook is also being built and deployed automatically on the Main branch, including a preview URL on each pull request. See it in action on this Azure Static Web App.
Contributing
We accept contributions to this project. However be aware that we are mainly working on a private backlog, so not everyone will be immediately obvious. If you want to get started on contributing, please read the contribute space where you will be able to find the guidelines on how to contribute as well as a list of good first issues.