mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-06 22:40:14 -05:00

History

renovate[bot] 4f4662490f Update Koenig packages (#21480 )		2024-10-31 10:11:27 +00:00
..
src	Made the tabs sticky in design and newsletter settings (#21477 )	2024-10-31 13:30:25 +08:00
test	Made the tabs sticky in design and newsletter settings (#21477 )	2024-10-31 13:30:25 +08:00
.eslintignore
.eslintrc.cjs
.yarnrc
index.html
node-shim.cjs
package.json	Update Koenig packages (#21480 )	2024-10-31 10:11:27 +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	Renamed admin-x-design to admin-x-design-system for clarity (#18914 )	2023-11-08 15:10:43 +00:00
tsconfig.json	Moved AdminX test config to framework package (#19096 )	2023-11-22 13:39:32 +00:00
vite.config.mjs	Custom fonts (#21337 )	2024-10-24 07:43:08 -04: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