Ghost/apps/admin-x-settings
Peter Zimon 9f19e334c1
Improve technical errors (#20046)
ref DES-229

Some of the error messages in Ghost and more specifically in Settings
were very technical, e.g.
`ValidationError: Validation (isEmpty) failed for locale`

This PR deals with some of the occurances for a more human error
communication.
2024-04-24 08:42:22 +02:00
..
src Improve technical errors (#20046) 2024-04-24 08:42:22 +02:00
test Improve technical errors (#20046) 2024-04-24 08:42:22 +02:00
.eslintignore Extracted AdminX design system to a separate package (#18878) 2023-11-08 12:33:18 +00:00
.eslintrc.cjs
.yarnrc
index.html
node-shim.cjs
package.json Update dependency vite to v4.5.3 [SECURITY] 2024-04-16 09:21:49 +02:00
playwright.config.mjs
postcss.config.cjs
README.md
tailwind.config.cjs
tsconfig.json
vite.config.mjs

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.

  1. git clone this repo & cd into it as usual
  2. 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