Testing tooling

.github/workflows/development.yml

@@ -117,6 +117,22 @@ jobs:
       - name: Run unit tests
         run: tox -e test-unit -- -m "smoke or sanity"
 
+  ui-unit-tests:
+    permissions:
+      contents: "read"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: src/ui
+
+      - name: Run unit tests
+        run: npm run test:unit
+        working-directory: src/ui
+
   integration-tests:
     runs-on: ubuntu-latest
     strategy:
@@ -133,6 +149,22 @@ jobs:
       - name: Run integration tests
         run: tox -e test-integration -- -m smoke
 
+  ui-integration-tests:
+    permissions:
+      contents: "read"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: src/ui
+
+      - name: Run integration tests
+        run: npm run test:integration
+        working-directory: src/ui
+
   build:
     runs-on: ubuntu-latest
     strategy:

.gitignore

@@ -221,4 +221,4 @@ src/ui/next-env.d.ts
 !package.json
 !package-lock.json
 !.eslintrc.json
-!tsconfig.json
+!tsconfig.*.json

DEVELOPING.md

@@ -179,6 +179,68 @@ Review the coverage report to confirm that your new code is adequately tested.
 
 3. **Address Feedback**: Respond to any feedback from reviewers and make necessary changes.
 
+## Developing the Web UI
+
+The GuideLLM project includes a frontend UI located in `src/ui`, built using [Next.js](https://nextjs.org/). This section provides instructions for working on the UI.
+
+### Getting Started
+
+To start the local development server:
+
+```bash
+npm run dev
+```
+
+Then open [http://localhost:3000](http://localhost:3000) in your browser.
+
+### Building for Production
+
+To build the app for production (output in the `out` directory):
+
+```bash
+npm run build
+```
+
+### Running UI Tests
+
+- **Unit tests**:
+
+  ```bash
+  npm run test:unit
+  ```
+
+- **Integration tests**:
+
+  ```bash
+  npm run test:integration
+  ```
+
+- **End-to-end tests** (using Cypress, ensure live dev server):
+
+  ```bash
+  npm run test:e2e
+  ```
+
+### Code Quality and Styling
+
+- **Fix styling issues**:
+
+  ```bash
+  npm run format
+  ```
+
+- **Run ESLint checks**:
+
+  ```bash
+  npm run lint
+  ```
+
+- **Run TS type checks**:
+
+  ```bash
+  npm run type-checks
+  ```
+
 ## Additional Resources
 
 - [CONTRIBUTING.md](https://github.com/neuralmagic/guidellm/blob/main/CONTRIBUTING.md): Guidelines for contributing to the project.