mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-11-23 11:55:01 +03:00
84a9a7dacc
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.
|
||
|---|---|---|
| .. | ||
| .storybook | ||
| src | ||
| test | ||
| .eslintrc.cjs | ||
| .yarnrc | ||
| index.html | ||
| node-shim.cjs | ||
| package.json | ||
| playwright.config.ts | ||
| postcss.config.cjs | ||
| README.md | ||
| tailwind.config.cjs | ||
| tsconfig.json | ||
| tsconfig.node.json | ||
| vite.config.ts | ||
Admin X Settings
Ghost Admin Settings in React
Development
Pre-requisites
- Run
yarnin Ghost monorepo root
Running the development version
Run yarn dev to start the development server to test/develop the settings standalone. This will generate a demo site from the index.html file which renders the app and makes it available on http://localhost:5173
Running inside Admin
Run yarn dev (like you would run Ghost dev normally) from the top-level repo. AdminX will automatically rebuild when you make changes.
Develop
This is a monorepo package.
Follow the instructions for the top-level repo.
git clonethis repo &cdinto it as usual- Run
yarnto install top-level dependencies.
Test
yarn lintrun just eslintyarn test:acceptanceruns acceptance testsyarn test:unitruns unit testsyarn test:acceptance path/to/testruns a specific testyarn test:acceptance:slowmoruns acceptance tests in slow motion and headed mode, useful for debugging and developing tests