Skip to content

Commit

Permalink
update README file with cockpit changes
Browse files Browse the repository at this point in the history
  • Loading branch information
mgold1234 committed Oct 8, 2024
1 parent 6525605 commit 14f5ee3
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,29 @@ see the [osbuild-getting-started project](https://github.com/osbuild/osbuild-get
## File Structure
### OnPremise Development - Cockpit Build and Install
## Overview
The following scripts are used to build the frontend with Webpack and install it into the Cockpit directories. These scripts streamline the development process by automating build and installation steps.
### Scripts
#### 1. Build the Cockpit Frontend
Runs Webpack with the specified configuration (cockpit/webpack.config.ts) to build the frontend assets.
Use this command whenever you need to compile the latest changes in your frontend code.
Creates the necessary directory in the user's local Cockpit share (~/.local/share/cockpit/).
Creates a symbolic link (image-builder-frontend) pointing to the built frontend assets (cockpit/public).
Use this command after building the frontend to install it locally for development purposes.
The symbolic link allows Cockpit to serve the frontend assets from your local development environment, making it easier to test changes in real-time without deploying to a remote server.
```bash
npm run cockpit:build
```bash
npm run cockpit:install
### Quick Reference
| Directory | Description |
| --------- | ----------- |
Expand Down

0 comments on commit 14f5ee3

Please sign in to comment.