History

Peter Zimon 770f657ae9 Improve messaging and error handling (#20078 ) ref DES-228 This PR updates messaging and error handling in order to make Ghost calmer and friendlier. High level summary of the changes: - Removed all onBlur validation in Settings -> now it’s possible to just click around without being warned to fill mandatory fields - Removed lot of technical errors like `ValidationError: Validation (isEmpty) failed for locale` - Completely removed the red background toast notifications, it was aggressive and raw esp. on the top - Removed some unnecessary notifications (e.g. when removing a webhook, the removal already communicates the result) - Now we show field errors on submitting forms, and in case of an error we show a “Retry” button in Settings too. This allowed to remove a lot of unnecessary error messages, like the big error message on the top, plus it’s consistent with the patterns outside Settings. - Notification style is white now with filled color icons which makes everything much calmer and more refined. - Removes redundant copy (e.g. "successful(ly)") from notifications --------- Co-authored-by: Sodbileg Gansukh <sodbileg.gansukh@gmail.com>		2024-05-14 09:31:19 +02:00
..
src	Improve messaging and error handling (#20078 )	2024-05-14 09:31:19 +02:00
test	Improve messaging and error handling (#20078 )	2024-05-14 09:31:19 +02:00
.eslintignore	Extracted AdminX design system to a separate package (#18878 )	2023-11-08 12:33:18 +00:00
.eslintrc.cjs	Temporarily fixed eslint rules being disabled in AdminX (#17565 )	2023-08-02 08:37:51 +01:00
.yarnrc	Prevented git tags from being created for apps	2023-07-10 13:09:28 +02:00
index.html
node-shim.cjs	Port custom theme setting visibility to admin-x (#18367 )	2023-10-02 15:54:14 +01:00
package.json	Improved performance for filter strings with multiple neq statements (#20198 )	2024-05-13 10:35:27 -05: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	Updated Admin-X settings readme (#18721 )	2023-10-23 10:22:03 +07:00
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	Extracted Unsplash Selector from AdminX (#19849 )	2024-03-12 22:40:33 +02: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