94a181ce2a
refs https://github.com/TryGhost/Product/issues/4123 --- <!-- Leave the line below if you'd like GitHub Copilot to generate a summary from your commit --> <!-- copilot:summary --> ### <samp>🤖 Generated by Copilot at a420f0b</samp> This pull request moves most of the API-related types and functions from the `admin-x-settings` package to the `admin-x-framework` package, which is a new library of common utilities and hooks for the admin-x apps. It also adds some configuration files, such as `.eslintrc.cjs` and `.gitignore`, to the `admin-x-framework` package. Additionally, it exports the `FetchKoenigLexical` type from the `admin-x-design-system` package, which is used by the `HtmlEditor` component. |
||
|---|---|---|
| .. | ||
| src | ||
| test | ||
| .eslintignore | ||
| .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