Ghost/apps/admin-x-settings/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.
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` run lint and tests
Added new package for admin-x settings refs https://github.com/TryGhost/Team/issues/3151 - adds a new vite + typescript + storybook + TW package for setting up admin settings in react with base config that works with Ghost monorepo - includes base components/design system for new settings UI - adds eslint rule config to the package to match rest of Ghost codebase - this is an experimental package as we figure out the best patterns for new admin packages in Ghost monorepo Co-authored-by: Peter Zimon <zimo@ghost.org> 2023-05-16 09:23:36 +03:00			`# 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`

Added `--adminX` functionality to `yarn dev` fixes https://github.com/TryGhost/Toolbox/issues/581 - this adds support for spinning up AdminX within the `yarn dev` script with zero other steps needed 2023-05-19 11:32:13 +03:00			Run `yarn dev` from the top-level repo with `--adminX`
Added new package for admin-x settings refs https://github.com/TryGhost/Team/issues/3151 - adds a new vite + typescript + storybook + TW package for setting up admin settings in react with base config that works with Ghost monorepo - includes base components/design system for new settings UI - adds eslint rule config to the package to match rest of Ghost codebase - this is an experimental package as we figure out the best patterns for new admin packages in Ghost monorepo Co-authored-by: Peter Zimon <zimo@ghost.org> 2023-05-16 09:23:36 +03:00
			`## 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` run lint and tests