Skip to content

Update @labkey package versions and add demo-queryModel.view info to README #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cnathe merged 1 commit into from
Dec 17, 2020
Merged

Update @labkey package versions and add demo-queryModel.view info to README #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions demo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,17 @@ including keeping the standard LabKey header and header menus.
Clone the tutorialModules repo into `/server/modules` directory and add the directory in `settings.gradle`. You can then build this module
using the [LabKey Gradle build]. This will install necessary packages, generate resources and put resources in correct LabKey module's directories.

There are two example React pages:
There are three example React pages:
- http://localhost:8080/labkey/home/demo-helloWorld.view?
- http://localhost:8080/labkey/home/demo-queryModel.view?
- http://localhost:8080/labkey/home/demo-todoList.view?

Also, this module has an example of using the todoList page in a LabKey webpart.

One of the example React pages, `demo-queryModel.view`, has example usages of components from
the LabKey React shared component library, `@labkey/components`. You can see more details and
documentation regarding these shared components from the [Public API doc] page.

<a name="functionality"></a>
# Functionality Overview
The compilation and packaging of this module, including the NPM/webpack build, is done with the standard LabKey Gradle build.
Expand All @@ -35,6 +40,7 @@ to allow updates made to TypeScript, JavaScript, CSS and SCSS files to take effe
start the server, from the command line in the demo module directory run `npm start`, then navigate to either of the appropriate development
pages (note the "Dev" added to the end of the action name).
- http://localhost:8080/labkey/home/demo-helloWorldDev.view?
- http://localhost:8080/labkey/home/demo-queryModelDev.view?
- http://localhost:8080/labkey/home/demo-todoListDev.view?

<a name="jest"></a>
Expand All @@ -44,4 +50,5 @@ Jest snapshot in the HelloWorld module. Jest tests can be run using `npm run te


[LabKey Gradle build]: https://www.labkey.org/Documentation/wiki-page.view?name=gradleBuild
[Node.js Build Dependency]: https://www.labkey.org/Documentation/wiki-page.view?name=nodejs
[Node.js Build Dependency]: https://www.labkey.org/Documentation/wiki-page.view?name=nodejs
[Public API doc]: https://github.com/LabKey/labkey-ui-components/blob/master/packages/components/docs/public.md
Loading