History

Simon Backx 3bc068123c Wired up checkbox to toggle tier visibility (#19260 ) fixes PROD-200		2023-12-06 17:36:18 +01:00
..
src	Wired up checkbox to toggle tier visibility (#19260 )	2023-12-06 17:36:18 +01:00
test	Show Add offer button on settings screen if no offer is present (#19215 )	2023-12-06 04:31:48 +00:00
.eslintignore
.eslintrc.cjs
.yarnrc
index.html
node-shim.cjs
package.json	Update Types packages	2023-12-04 22:05:57 +01:00
playwright.config.mjs	Moved AdminX test config to framework package (#19096 )	2023-11-22 13:39:32 +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