TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-18 05:52:40 +03:00
Code Issues Projects Releases Wiki Activity
e437d5e420
Ghost/apps/admin-x-settings
History
Jono M 94a181ce2a
Separated common AdminX logic into a reusable package (#18919) 
refs https://github.com/TryGhost/Product/issues/4123

---

<!-- Leave the line below if you'd like GitHub Copilot to generate a
summary from your commit -->
<!--
copilot:summary
-->
### <samp>🤖 Generated by Copilot at a420f0b</samp>

This pull request moves most of the API-related types and functions from
the `admin-x-settings` package to the `admin-x-framework` package, which
is a new library of common utilities and hooks for the admin-x apps. It
also adds some configuration files, such as `.eslintrc.cjs` and
`.gitignore`, to the `admin-x-framework` package. Additionally, it
exports the `FetchKoenigLexical` type from the `admin-x-design-system`
package, which is used by the `HtmlEditor` component.
2023-11-14 13:50:08 +00:00
..
src Separated common AdminX logic into a reusable package (#18919) 2023-11-14 13:50:08 +00:00
test Added tests for edit offer 2023-11-09 23:58:49 +05:30
.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 Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
node-shim.cjs Port custom theme setting visibility to admin-x (#18367) 2023-10-02 15:54:14 +01:00
package.json Separated common AdminX logic into a reusable package (#18919) 2023-11-14 13:50:08 +00:00
playwright.config.ts Renamed e2e tests to acceptance tests in Admin X (#18439) 2023-10-03 16:20:40 +07:00
postcss.config.cjs Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02: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 Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
tsconfig.node.json Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
vite.config.ts Port custom theme setting visibility to admin-x (#18367) 2023-10-02 15:54:14 +01: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.

  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