mirror of
https://github.com/TryGhost/Ghost.git
synced 2023-12-13 21:00:40 +01:00
8c5e2a53a9
refs https://github.com/TryGhost/Toolbox/issues/594 - we're moving all the external apps into a different folder so we can keep `ghost/` for internal code
33 lines
778 B
Markdown
33 lines
778 B
Markdown
# 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
|