src/Umbraco.Web.UI.Client/README.md

# Umbraco.CMS.Backoffice

## Installation instructions

1. Run `npm install`
2. Run `npm run dev` to 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:

```bash
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:

```bash
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](https://ashy-bay-09f36a803.1.azurestaticapps.net/). 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](https://ambitious-stone-0033b3603.1.azurestaticapps.net/).
Update README.md 2022-05-17 10:11:26 +02:00			`# Umbraco.CMS.Backoffice`

update README with installation instructions 2022-06-01 14:09:22 +02:00			`## Installation instructions`

			1. Run `npm install`
			2. Run `npm run dev` to 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:

			```bash
Update README.md 2022-08-01 11:14:55 +02:00			`VITE_UMBRACO_INSTALL_STATUS=must-install`
update README with installation instructions 2022-06-01 14:09:22 +02:00			```

Update README.md 2022-05-17 10:11:26 +02:00			`## Environments`

Allow msw bypass (#246) * add new variable to hold the url to the local umbraco instance * set api base-url if msw is turned off * add instructions how to use local umbraco instance * set baseurl for e2e mode Co-authored-by: Mads Rasmussen <madsr@hey.com> 2022-11-14 14:45:35 +01:00			`### 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:

			```bash
			`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)`
			```

add link to storybook 2022-08-09 13:37:28 +02:00			`### Static website`

update README with installation instructions 2022-06-01 14:09:22 +02:00			See the Main branch in action here as an [Azure Static Web App](https://ashy-bay-09f36a803.1.azurestaticapps.net/). 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.
add link to storybook 2022-08-09 13:37:28 +02:00
			`### 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](https://ambitious-stone-0033b3603.1.azurestaticapps.net/).`