History

Ronald Langeveld 63d912b2d8 Added content visibility feature flag (#20371 ) ref MOM-221 - added new feature flag for content visibility.		2024-06-12 16:55:47 +07:00
..
src	Added content visibility feature flag (#20371 )	2024-06-12 16:55:47 +07:00
test	Updated error message shown when trying to overwrite a default theme (#20301 )	2024-05-31 21:01:44 +00:00
.eslintignore
.eslintrc.cjs
.yarnrc
index.html	Moved Admin-X-Settings to `apps/` folder	2023-06-23 14:37:39 +02:00
node-shim.cjs
package.json	Added '@' internal link shortcut to editor (#20272 )	2024-05-29 18:13:52 +01:00
playwright.config.mjs
postcss.config.cjs
README.md
tailwind.config.cjs
tsconfig.json
vite.config.mjs

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