History

Daniel Lockyer fc02ca8bbb Reverted "Update Vite packages" refs https://ghost.slack.com/archives/C0568LN2CGJ/p1702454781859679 - this reverts commit `cf60db85d8` as we've seen issues with the `vite-plugin-css-injected-by-js` dependency		2023-12-13 09:24:29 +01:00
..
src	Dark mode improvements for offers (#19352 )	2023-12-13 07:40:40 +00:00
test	Updated copy of the add offer link in the settings group (#19323 )	2023-12-12 12:28:53 +07:00
.eslintignore
.eslintrc.cjs
.yarnrc
index.html
node-shim.cjs
package.json	Reverted "Update Vite packages"	2023-12-13 09:24:29 +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