Skip to content

Commit e25f4a7

Browse files
committed
docs: merge authentication.md into README.md and let people know they should report issues on Umbraco-CMS
1 parent ad80549 commit e25f4a7

File tree

2 files changed

+25
-71
lines changed

2 files changed

+25
-71
lines changed

.github/README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,6 @@ The development environment is the default environment and is used when running
2929

3030
### Run against a local Umbraco instance
3131

32-
> **Note**
33-
> Make sure you have followed the [Authentication guide](https://github.com/umbraco/Umbraco.CMS.Backoffice/blob/main/docs/authentication.md) before continuing.
34-
3532
If you have a local Umbraco instance running, you can use the development environment to run against it by overriding the API URL and bypassing the mock-service-worker in the frontend client.
3633

3734
Create a `.env.local` file and set the following variables:
@@ -41,14 +38,37 @@ VITE_UMBRACO_API_URL=https://localhost:44339 # This will be the URL to your Umbr
4138
VITE_UMBRACO_USE_MSW=off # Indicate that you want all API calls to bypass MSW (mock-service-worker)
4239
```
4340

41+
Open this file in an editor: `src/Umbraco.Web.UI/appsettings.Development.json` and add this to the `Umbraco:CMS:Security` section to override the backoffice host:
42+
43+
```json
44+
"Umbraco": {
45+
"CMS": {
46+
"Security":{
47+
"BackOfficeHost": "http://localhost:5173",
48+
"AuthorizeCallbackPathName": "/oauth_complete",
49+
"AuthorizeCallbackLogoutPathName": "/logout",
50+
"AuthorizeCallbackErrorPathName": "/error",
51+
},
52+
},
53+
}
54+
```
55+
56+
Now start the vite server: `npm run dev:server` in your backoffice folder and open the http://localhost:5173 URL in your browser.
57+
4458
### Storybook
4559

4660
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/).
4761

62+
You can test the Storybook locally by running `npm run storybook`. This will start the Storybook server and open a browser window with the Storybook UI.
63+
64+
Storybook is an excellent tool to test out UI components in isolation and to document them. It is also a great way to test the responsiveness and accessibility of the components.
65+
4866
## Contributing
4967

50-
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](https://github.com/umbraco/Umbraco.CMS.Backoffice/contribute) where you will be able to find the guidelines on how to contribute as well as a list of good first issues.
68+
We accept contributions to this project. However be aware that we are mainly working on a private backlog, so not everything will be immediately obvious. If you want to get started on contributing, please read the [contributing guidelines](./CONTRIBUTING.md).
69+
70+
A list of issues can be found on the [Umbraco-CMS Issue Tracker](https://github.com/umbraco/Umbraco-CMS/issues). Many of them are marked as `community/up-for-grabs` which means they are up for grabs for anyone to work on.
5171

5272
## Documentation
5373

54-
The documentation can be found on [Umbraco Docs](https://docs.umbraco.com/umbraco-backoffice/). The documentation is a work in progress.
74+
The documentation can be found on [Umbraco Docs](https://docs.umbraco.com/umbraco-cms).

docs/authentication.md

Lines changed: 0 additions & 66 deletions
This file was deleted.

0 commit comments

Comments
 (0)