OpenSourceArk/Ghost
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Admin-X settings readme (#18721)

Browse Source 
no issue

- Updated the readme document for AdminX, Settings.

---

<!-- Leave the line below if you'd like GitHub Copilot to generate a
summary from your commit -->
<!--
copilot:summary
-->
### <samp>🤖 Generated by Copilot at 728a9a3</samp>

Improved the documentation of the `admin-x-settings` project by updating
the `README.md` file. Removed obsolete information and added new testing
options.
This commit is contained in:
Ronald Langeveld 2023-10-23 10:22:03 +07:00 committed by GitHub
parent f18287eb9b
commit 84a9a7dacc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
apps/admin-x-settings/README.md
View File

@ -1,13 +1,12 @@
# Admin X Settings
Experimental re-write of Ghost Admin Settings in React
Ghost Admin Settings in React
## Development
### Pre-requisites
- Run `yarn` in Ghost monorepo root
- Run `yarn` in this directory
### Running the development version
@ -15,7 +14,7 @@ Run `yarn dev` to start the development server to test/develop the settings stan
### Running inside Admin
Run `yarn dev` from the top-level repo with `--adminX`
Run `yarn dev` (like you would run Ghost dev normally) from the top-level repo. AdminX will automatically rebuild when you make changes.
## Develop
@ -30,4 +29,7 @@ Follow the instructions for the top-level repo.
## Test
- `yarn lint` run just eslint
- `yarn test` run lint and tests
- `yarn test:acceptance` runs acceptance tests
- `yarn test:unit` runs unit tests
- `yarn test:acceptance path/to/test` runs a specific test
- `yarn test:acceptance:slowmo` runs acceptance tests in slow motion and headed mode, useful for debugging and developing tests