cheetas3.webui v1.0.0
Cheetas3.React.UIs monorepo
Top level layout
| Folder | Description |
|---|---|
| apps | the main runnable applications |
| lib | library code imported by an app (not 3rd party) |
| baseline | Cheetas baseline modules not bundled with the main UI |
Projects
| Project | Description |
|---|---|
| apps/user | Cheetas user UI application |
| apps/admin | Cheetas admin UI application |
| lib/core | core library where most components live, if not specific to an app or module |
| lib/module | core library for Cheetas web modules |
| baseline/icd-manager | ICD manager admin module |
Referencing code
Symbols have been added to allow you to easily reference other parts of the repo | Symbol | Description | Example | ------ | ----------- | ------- | @core | "src" folder of core library | @core/components/common/Toaster/Toaster | @module | "src" folder of module library | @module/react/CheetasModule
Tasks
Adding NPM package
Run npm install in the folder with the package.json that you want to install the package to, normally. If you add a package to lib/core, you will most likely need to add it to one of the apps as well.
Building everything
Run "npm run dist --ws" in the root of the monorepo.
Running a single app
Run "npm start" in an app folder to run an app in development mode. Run "npm start" in a baseline folder to run a module in development mode.
Updating Cheetas API / Redux
Run "npm run update:redux" in lib/core.
To Generate an API from swagger docs
npx swagger-typescript-api -p https://localhost:5001/swagger/v1/swagger.json -o ./application --modular
10 months ago