History

Michael Barrett ed0762fb51 Removed usage of `yg` when using NQL (#19287 ) refs https://github.com/TryGhost/NQL/pull/73 The referenced PR removes `yg` from the parsed NQL output, so we also need to remove any usage of it in Ghost		2024-01-15 14:40:01 +00:00
..
src	🐛 Fixed outside click exiting Code Injection modal (#19424 )	2024-01-05 10:53:57 +00:00
test	Removed onBlur error feedback in Recommendation edit modal (#19382 )	2023-12-14 13:09:55 +00:00
.eslintignore
.eslintrc.cjs
.yarnrc
index.html
node-shim.cjs
package.json	Removed usage of `yg` when using NQL (#19287 )	2024-01-15 14:40:01 +00:00
playwright.config.mjs	Updated files with mixed named/default exports to use only named exports (#19385 )	2023-12-14 16:01:28 +00:00
postcss.config.cjs	Created a skeleton AdminX demo app (#19005 )	2023-11-20 13:30:15 +00:00
README.md
tailwind.config.cjs
tsconfig.json	Moved AdminX test config to framework package (#19096 )	2023-11-22 13:39:32 +00:00
vite.config.mjs	Created a skeleton AdminX demo app (#19005 )	2023-11-20 13:30:15 +00:00

README.md

Admin X Settings

Ghost Admin Settings in React

Development

Pre-requisites

Run yarn in 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 clone this repo & cd into it as usual
Run yarn to install top-level dependencies.

Test

yarn lint run just eslint
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