History

renovate[bot] a1dc3d4f33 Update dependency typescript to v5.0.4		2023-05-19 12:39:23 +02:00
..
.storybook	Refinements in Admin X DS	2023-05-17 19:01:01 +02:00
public	Updated dev. env. setup for Admin X Settings	2023-05-17 07:47:10 +02:00
src	Added toggle component to AdminX design system	2023-05-19 12:29:42 +02:00
test
.eslintrc.cjs
.yarnrc
index.html
package.json	Update dependency typescript to v5.0.4	2023-05-19 12:39:23 +02:00
postcss.config.cjs	Updated dev. env. setup for Admin X Settings	2023-05-17 07:47:10 +02:00
README.md	Added `--adminX` functionality to `yarn dev`	2023-05-19 10:34:06 +02:00
tailwind.config.cjs	Fixed type antipattern in Admin X Settings	2023-05-19 06:13:57 +02:00
tsconfig.json
tsconfig.node.json
vite.config.ts	Added `--adminX` functionality to `yarn dev`	2023-05-19 10:34:06 +02:00

README.md

Admin X Settings

Experimental re-write of Ghost Admin Settings in React

Development

Pre-requisites

Run yarn in Ghost monorepo root
Run yarn in this directory

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 from the top-level repo with --adminX

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 run lint and tests