Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-20 22:42:53 -05:00
Code Issues Activity
ghost/apps/admin-x-settings
History
Jono M a93c665d20
Created a skeleton AdminX demo app (#19005) 
refs https://github.com/TryGhost/Product/issues/4152

---

<!-- Leave the line below if you'd like GitHub Copilot to generate a
summary from your commit -->
<!--
copilot:summary
-->
### <samp>🤖[[deprecated]](https://githubnext.com/copilot-for-prs-sunset)
Generated by Copilot at a28462f</samp>

This pull request adds a new admin-x app called `admin-x-demo`, which
demonstrates how to use the shared packages `admin-x-framework` and
`admin-x-design-system` to create a simple app that renders a button and
a modal. It also improves the development workflow, the vite
integration, the dependency management, and the type checking for the
admin-x apps and packages. It modifies some files in the
`admin-x-framework` and `admin-x-design-system` packages to make the
modals prop optional, to introduce a new type for the props from the
Ember app, to fix the z-index of the modal backdrop, and to use
consistent file extensions and module syntax.
2023-11-20 13:30:15 +00:00
..
src Created a skeleton AdminX demo app (#19005) 2023-11-20 13:30:15 +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
.yarnrc
index.html
node-shim.cjs Port custom theme setting visibility to admin-x (#18367) 2023-10-02 15:54:14 +01:00
package.json Update dependency @vitejs/plugin-react to v4.2.0 2023-11-20 09:42:07 +01: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 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 Created a skeleton AdminX demo app (#19005) 2023-11-20 13:30:15 +00:00
vite.config.mjs Created a skeleton AdminX demo app (#19005) 2023-11-20 13:30:15 +00: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