docs: revised generating typescript interfaces section #4504
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
connoratrug
reviewed
Nov 19, 2024
Comment on lines
+407
to
+409
| ### Generating interfaces and types for use in MOLGENIS fontend apps | ||
|
|
||
| To generate the typescript interfaces for a given schema, run: | ||
| `./gradlew generateTypes --args=[schemaName] [full-path+file-name]` | ||
| Throughout the EMX2 frontend, we use typescript for stronger typing and validation in our frontend components. To make things easier for developers, we've include a command for autogenerating typescript interfaces and types from an EMX2 schema. This process is outlined in the steps below. |
There was a problem hiding this comment.
somewhat verbose, prefer more direct style of current doc
connoratrug
reviewed
Nov 19, 2024
Comment on lines
+415
to
+427
| ```terminal | ||
| ./gradlew run | ||
| ``` | ||
|
|
||
| #### 2. Import your schema | ||
|
|
||
| Once your instance is live - | ||
|
|
||
| 1. Navigate to the local emx2 instance at [http://localhost:8080/](http://localhost:8080/) | ||
| 2. Sign in as admin or as another user that can create databases | ||
| 3. Create a new database (e.g., `My new database`) | ||
| 4. Import your EMX2 file into the new database | ||
|
|
There was a problem hiding this comment.
do not have to use this run command of create an new database to generate the types
connoratrug
reviewed
Nov 19, 2024
|
|
||
| #### 3. Generate the interfaces and types | ||
|
|
||
| In your application folder (`apps/*`), create a directory to store the types (e.g., "types", "interfaces", etc.). The command is `generateTypes`. The syntax to generate the file is described below. |
There was a problem hiding this comment.
does not have to be in the apps folder
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What are the main changes you did
How to test
Checklist