Ghost/apps/admin-x-settings
Daniel Lockyer 0a6cd75993 Gated NestJS framework behind environment variable
- we added NestJS to Ghost as a way forwards for a new framework within
  Ghost but we haven't added much to it
- requiring all the NestJS code adds about 6-9% to our boot time, so if
  we're not using it, it's just time we're burning for no benefit
- for now, I've gated this behind an env var to prevent it from loading
- we can't use labs flags in the boot process, so I've gone for an env
  var
2024-08-29 12:18:42 +02:00
..
src Gated NestJS framework behind environment variable 2024-08-29 12:18:42 +02:00
test Hid tips and donation settings when Stripe is disabled 2024-08-21 16:12:00 +01: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 Updated nql package (#20811) 2024-08-22 07:55:14 +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 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

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