Skip to content

Commit

Permalink
Upgrade readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcelGeo committed Dec 4, 2023
1 parent d4e78ae commit dcc67b2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion development.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Before installing the web applications, make sure you have Node.js installed in
$ cd web-app
$ yarn install
$ yarn link:dependencies # link dependencies
$ yarn build:libs # bild libraries @mergin/lib @mergin/admin-lib
$ yarn build:libs # bild libraries @mergin/lib @mergin/admin-lib @mergin/lib-vue2
$ yarn dev # development client web application dev server on port 8080 (package @mergin/app)
$ yarn dev:admin # development admin appplication dev server on port 8081 (package @mergin/admin-app)
```
Expand Down
3 changes: 3 additions & 0 deletions web-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,13 @@ Monorepo for mergin frontend stuff:
Application constist of several packages in `packages` directory:

- @mergin/lib - Shared library for common features
- @mergin/lib-vue2 - Shared library for common features with vuetify and vue 2.7
- @mergin/admin-lib - Shared library for admin
- @mergin/app - Web appliacation
- @mergin/admin-app - Web application for administration

Library packages with *-lib* name are containing shared code for *-app* applications.

Web application *@mergin/app* is using shared library *@mergin/lib*. Web application for administratio *admin-app* is using shared libraries with vue 2.7 *@mergin/admin-lib* and *@mergin/lib-vue2*.

For details about development follow instructions in [development guide](../development.md).

0 comments on commit dcc67b2

Please sign in to comment.