yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add README for temp schema generator

Browse Source
This commit is contained in:
Jacob Overgaard
2022-05-25 14:33:22 +02:00
parent 45aa6d0fe6
commit 8df4dcbbc3
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/Umbraco.Web.UI.Client/temp-schema-generator/README.md Normal file
View File

@@ -0,0 +1,12 @@
# What is this?
This folder contains the schema generator which resides here temporarily until Umbraco provides a proper way to generate schemas in its own repository.
## How do I use it?
1. Run `npm install` in this folder.
2. Update any schema through `api.ts` and then run `npm run generate` to simulate a new schema.
3. You then need to go to the main folder and run `npm run generate:api` to generate the API fetchers and interfaces.
1. This is the only thing that will remain in the final version.
We are using the excellent tool `@airtasker/spot` to decorate the schema methods. [You can read more about it here](https://github.com/airtasker/spot).