Frontend: Build, wireframe, config (#26)

## Summary
This PR includes significant updates to the project:

### 1. Frontend Built and Served with Node.js
- The frontend is now built and served using Node.js, allowing for
**Server-Side Rendering (SSR)**. This can lead to faster load times if
we choose to enable it (which I have). Additionally, Node.js provides
more flexibility for future configuration, as it's JavaScript-based.

### 2. Initial Wireframe of the App
- A basic wireframe has been created for the app, featuring a left
navigation bar, API calls, and configurations. As Eugene progresses,
we'll expand on this wireframe to better reflect the final design.

### 3. App Configuration
- Set up various app-specific configurations to integrate
**shadcn-svelte**, **Tailwind**, **ECharts**, and other necessary
libraries. This foundational work will make future development smoother.

In the future, I'll aim to break down updates into smaller, more
manageable pull requests.

### Relevant Commands:
- **From `/chronon/frontend`:**  
  `npm run dev`  
This command starts the development server locally. Ensure the backend
is running at `localhost:9000` before starting.

- **From `/chronon`:**  
  `docker-compose -f docker-init/compose.yaml up --build`  
This builds both the backend and frontend using Docker. The frontend
will use the `.env.docker` environment variables. The backend will start
at `http://localhost:9000/` and the frontend at `http://localhost:3000/`

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
	- Introduced a new frontend service in Docker configuration.
	- Added a module for handling API requests, simplifying GET requests.
- Enhanced README for the frontend with updated installation and testing
instructions.
	- Implemented Tailwind CSS for custom theming in the frontend.
	- Added support for a dark theme in the application.
	- Introduced a new configuration file for frontend components.
- Added environment variables for API base URLs in development and
Docker.

- **Bug Fixes**
- Updated instructions for accessing backend and frontend services in
Docker documentation.

- **Documentation**
	- Restructured README files for clearer guidance on setup and usage.
	- Added new configuration files for PostCSS and component settings.

- **Chores**
- Expanded `.gitignore` to exclude additional build artifacts and
temporary files.
- Updated dependency versions and build commands in configuration files.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Piyush Narang <[email protected]>

Author: ken-zlai

.gitignore

@@ -60,12 +60,9 @@ releases
 /frontend/.DS_Store
 /frontend/Thumbs.db
 
-# Frontend Env
-/frontend/.env
-/frontend/.env.*
-!/frontend/.env.example
-!/frontend/.env.test
-
 # Frontend Vite
 /frontend/vite.config.js.timestamp-*
 /frontend/vite.config.ts.timestamp-*
+
+# Frontend Test Results
+/frontend/test-results

build.sbt

@@ -193,7 +193,7 @@ lazy val frontend = (project in file("frontend"))
       }
 
       println("Building frontend...")
-      val buildResult = Process("npm run build", file("frontend")).!
+      val buildResult = Process("npm run build:docker", file("frontend")).!
 
       if (buildResult == 0) {
         println("Copying frontend assets to /hub/public...")
@@ -224,9 +224,6 @@ lazy val hub = (project in file("hub"))
       "io.circe" %% "circe-generic" % circeVersion,
       "io.circe" %% "circe-parser" % circeVersion
     ),
-    // Ensure hub depends on frontend build
-    Compile / run := ((Compile / run) dependsOn (frontend / buildFrontend)).evaluated,
-    Compile / stage := ((Compile / stage) dependsOn (frontend / buildFrontend)).value
   )
 
 ThisBuild / assemblyMergeStrategy := {

docker-init/README.md

@@ -10,10 +10,12 @@ app-1           | [info] 2024-09-30 20:47:56,448 [main] INFO  play.api.Play - Ap
 app-1           | [info] 2024-09-30 20:47:56,665 [main] INFO  play.core.server.PekkoHttpServer - Listening for HTTP on /[0:0:0:0:0:0:0:0]:9000
 ```
 
-You can now pull up the web-server on http://localhost:9000
+The **backend** is served at: http://localhost:9000
+
+The **frontend** is served at: http://localhost:3000
 
 You can also access the parquet anomaly data table. To do so, from another terminal run:
 
-```docker-compose exec app bash```
+`docker-compose exec app bash`
 
 The parquet is available in the /app/data directory.

docker-init/compose.yaml

@@ -1,4 +1,4 @@
-name: 'hub-monitoring-demo'
+name: "hub-monitoring-demo"
 services:
   dynamo:
     command: "-jar DynamoDBLocal.jar -sharedDb -dbPath ./data"
@@ -21,8 +21,8 @@ services:
       - SPARK_SSL_ENABLED=no
       - SPARK_USER=spark
     ports:
-      - '8080:8080'
-      - '7077:7077'
+      - "8080:8080"
+      - "7077:7077"
 
   spark-worker:
     image: bitnami/spark:3.5.2
@@ -57,10 +57,26 @@ services:
       - PLAY_HTTP_SECRET_KEY=my_fake_chronon_monitoring_hub_http_secret_key # needs to be long to make Play happy
       - JAVA_OPTS=-Xms1g -Xmx1g
     ports:
-      - '9000:9000'
+      - "9000:9000"
     healthcheck:
       interval: 1s
       retries: 5
       start_period: 60s
       test: curl -sS --fail http://app:${APP_PORT:-9000}/api/v1/ping
       timeout: 5s
+
+  frontend:
+    build:
+      context: ..
+      dockerfile: docker-init/frontend/Dockerfile
+    depends_on:
+      - base
+      - app
+    ports:
+      - "3000:3000"
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:3000"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 40s

docker-init/frontend/Dockerfile

@@ -0,0 +1,24 @@
+FROM base_image:latest AS build_env
+
+# Copy the entire project directory into the container
+COPY . /app
+
+# Install Node.js and npm
+RUN apk add --update nodejs npm
+
+# Build the frontend using SBT
+RUN sbt "project frontend" buildFrontend
+
+FROM node:18-alpine
+
+# Copy the built frontend from the previous stage to the new container
+COPY --from=build_env app/frontend /app/frontend
+
+# Set the working directory for subsequent commands
+WORKDIR /app/frontend
+
+# Expose port 3000 for the SvelteKit app
+EXPOSE 3000
+
+# Specify the command to run when the container starts
+CMD ["node", "build/index.js"]

frontend/.env

@@ -0,0 +1 @@
+VITE_API_BASE_URL=http://localhost:9000

frontend/.env.docker

@@ -0,0 +1 @@
+VITE_API_BASE_URL=http://app:9000

frontend/README.md

@@ -1,38 +1,144 @@
-# create-svelte
+# Chronon Frontend
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
+The frontend for Chronon.
 
-## Creating a project
+## Getting Started
 
-If you're seeing this, you've probably already done this step. Congrats!
+### Prerequisites
+
+- [Node.js](https://nodejs.org/en/) (LTS version recommended)
+- npm (comes with Node.js)
+
+### Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/zipline-ai/chronon.git
+   cd chronon
+   ```
+
+2. Navigate to the frontend directory:
+
+   ```bash
+   cd frontend
+   ```
+
+3. Install dependencies:
+   ```bash
+   npm install
+   ```
+
+### Development
+
+To start the development server:
+
+1. First, start the backend project:
 
 ```bash
-# create a new project in the current directory
-npm create svelte@latest
+# Run this command in the root directory
+sbt "project hub" run
+```
+
+2. Then, start the development server:
 
-# create a new project in my-app
-npm create svelte@latest my-app
+```bash
+npm run dev
 ```
 
-## Developing
+This will start a local server. The app will automatically reload if you make changes to the code.
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+### Build
+
+To create an optimized production build:
 
 ```bash
-npm run dev
+npm run build
+```
+
+This will create an optimized version of your project in the `build` directory.
+
+### Preview
 
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
+To preview the production build locally:
+
+```bash
+npm run preview
 ```
 
-## Building
+### Running Tests
 
-To create a production version of your app:
+#### All Tests
+
+To run both unit and integration tests together:
 
 ```bash
-npm run build
+npm run test
+```
+
+#### Unit Tests
+
+To run unit tests using Vitest:
+
+```bash
+npm run test:unit
+```
+
+To run unit tests once:
+
+```bash
+npm run test:unit:once
+```
+
+#### Integration Tests
+
+To run integration tests using Playwright:
+
+```bash
+npm run test:integration
+```
+
+To run integration tests once:
+
+```bash
+npm run test:integration:once
+```
+
+For the Playwright UI to explore test results:
+
+```bash
+npm run test:integration:ui
+```
+
+### Linting and Formatting
+
+To check code formatting and linting issues:
+
+```bash
+npm run lint
+```
+
+To format the codebase:
+
+```bash
+npm run format
+```
+
+### Type Checking
+
+To check the TypeScript types:
+
+```bash
+npm run check
+```
+
+To continuously check types while developing:
+
+```bash
+npm run check:watch
 ```
 
-You can preview the production build with `npm run preview`.
+## Best Practices
 
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
+1. **Code Style**: This project uses Prettier and ESLint for code formatting and linting. Please run `npm run lint` and `npm run format` before committing changes.
+2. **Testing**: Ensure all changes are covered with unit and integration tests. Use Vitest for unit tests and Playwright for integration tests.

frontend/components.json

@@ -0,0 +1,14 @@
+{
+	"$schema": "https://shadcn-svelte.com/schema.json",
+	"style": "new-york",
+	"tailwind": {
+		"config": "tailwind.config.js",
+		"css": "src/app.css",
+		"baseColor": "neutral"
+	},
+	"aliases": {
+		"components": "$lib/components",
+		"utils": "$lib/utils"
+	},
+	"typescript": true
+}

frontend/eslint.config.js

@@ -25,6 +25,15 @@ export default [
 			parserOptions: {
 				parser: ts.parser
 			}
+		},
+		rules: {
+			'@typescript-eslint/no-unused-vars': [
+				'error',
+				{
+					argsIgnorePattern: '^_',
+					varsIgnorePattern: '^\\$\\$(Props|Events|Slots|Generic)$'
+				}
+			]
 		}
 	},
 	{