Skip to content

Commit 3efc089

Browse files
vivian-xie-dbvivian-xie-db
committed
Add pre-built client for easy deployment
- Remove client/build/ from .gitignore - Include production build files in repository - Add RELEASE_NOTES.md with setup instructions - Users can now clone and run without building client
1 parent cb85bc3 commit 3efc089

File tree

7 files changed

+212
-1
lines changed

7 files changed

+212
-1
lines changed

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ __pycache__
66
.env
77
node_modules/
88
client/node_modules/
9-
client/build/
109
env.local
1110
.venv/
1211
.venv

‎RELEASE_NOTES.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Release v1.0.0
2+
3+
## 🎉 Initial Release - Pre-built Client Included
4+
5+
This release includes a pre-built client application so you can clone and run immediately without needing to build the frontend yourself.
6+
7+
## 📦 Quick Start
8+
9+
### Option 1: Use Pre-built Client (Recommended for Quick Setup)
10+
11+
1. **Clone the repository:**
12+
```bash
13+
git clone https://github.com/databricks-solutions/project-0xfffff.git
14+
cd project-0xfffff
15+
```
16+
17+
2. **Download and extract the pre-built client:**
18+
- Go to the [Releases page](https://github.com/databricks-solutions/project-0xfffff/releases/tag/v1.0.0)
19+
- Download `client-build.tar.gz`
20+
- Extract it in the project root:
21+
```bash
22+
tar -xzf client-build.tar.gz
23+
```
24+
This will create the `client/build/` directory with all the necessary files.
25+
26+
3. **Run the server:**
27+
```bash
28+
uv run uvicorn server.app:app --reload --port 8000
29+
```
30+
31+
4. **Open your browser:**
32+
```
33+
http://localhost:8000
34+
```
35+
36+
### Option 2: Build Client Yourself (For Development)
37+
38+
If you want to modify the client or build from source:
39+
40+
```bash
41+
cd client
42+
npm install
43+
npm run build
44+
cd ..
45+
uv run uvicorn server.app:app --reload --port 8000
46+
```
47+
48+
## ✨ Features in This Release
49+
50+
### Core Functionality
51+
- **Workshop Management**: Create and manage annotation workshops
52+
- **Discovery Phase**: Users explore traces and identify patterns
53+
- **Annotation Phase**: Rate traces based on custom rubrics
54+
- **IRR Analysis**: Calculate inter-rater reliability metrics
55+
- **MLflow Integration**: Import traces from MLflow experiments
56+
57+
### Key Fixes & Improvements
58+
59+
1. **Annotation Editing** - Users can edit previous ratings with smart change detection
60+
2. **Authentication Fix** - Resolved "permission denied" errors requiring page refresh
61+
3. **Comment Handling** - Multi-line comments with proper newline preservation
62+
4. **Rubric Format** - Fixed question parsing with improved delimiter
63+
5. **Trace Randomization** - Per-user randomized but consistent trace ordering
64+
6. **MLflow Deeplink Fix** - Removed trailing slash causing deeplink hangs
65+
66+
## 📋 Requirements
67+
68+
- Python 3.10+
69+
- uv (Python package installer)
70+
- Modern web browser
71+
72+
## 🔧 Configuration
73+
74+
See the main [README.md](README.md) for detailed configuration options including:
75+
- Database setup
76+
- Databricks integration
77+
- Authentication configuration
78+
- Workshop creation
79+
80+
## 📚 Documentation
81+
82+
- [BUILD_GUIDE.md](client/BUILD_GUIDE.md) - Client build instructions
83+
- [AUTHENTICATION_FIX.md](AUTHENTICATION_FIX.md) - Authentication details
84+
- [ANNOTATION_EDITING_FIX.md](ANNOTATION_EDITING_FIX.md) - Annotation editing
85+
- [TRACE_RANDOMIZATION.md](TRACE_RANDOMIZATION.md) - Randomization logic
86+
87+
## 🐛 Known Issues
88+
89+
None at this time. Please report issues on GitHub.
90+
91+
## 📝 License
92+
93+
See [LICENSE.md](LICENSE.md) for details.
94+

‎client/build/assets/index-B6B28LRi.js‎

Lines changed: 66 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎client/build/assets/index-DlsaUrTt.css‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎client/build/favicon.ico‎

Whitespace-only changes.

‎client/build/index.html‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<link rel="icon" href="/favicon.ico" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1" />
7+
<meta name="theme-color" content="#000000" />
8+
<meta name="description" content="DB Custom Judge Workshop App" />
9+
<link rel="apple-touch-icon" href="/logo192.png" />
10+
<link rel="manifest" href="/manifest.json" />
11+
<title>DB Custom Judge Workshop App</title>
12+
<script type="module" crossorigin src="/assets/index-B6B28LRi.js"></script>
13+
<link rel="stylesheet" crossorigin href="/assets/index-DlsaUrTt.css">
14+
</head>
15+
<body>
16+
<noscript>You need to enable JavaScript to run this app.</noscript>
17+
<div id="root"></div>
18+
<script>
19+
// Auto-reload on asset loading failures (cache issues)
20+
window.addEventListener('error', function(e) {
21+
if (e.target.tagName === 'SCRIPT' || e.target.tagName === 'LINK') {
22+
const hasReloaded = sessionStorage.getItem('asset-reload');
23+
if (!hasReloaded) {
24+
sessionStorage.setItem('asset-reload', 'true');
25+
window.location.reload(true);
26+
}
27+
}
28+
}, true);
29+
30+
// Clear reload flag after successful load
31+
window.addEventListener('load', function() {
32+
setTimeout(() => sessionStorage.removeItem('asset-reload'), 1000);
33+
});
34+
</script>
35+
</body>
36+
</html>

‎client/build/manifest.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"short_name": "Data Workshop",
3+
"name": "Databricks LLM-Judge Builder Workshop",
4+
"icons": [
5+
{
6+
"src": "favicon.ico",
7+
"sizes": "64x64 32x32 24x24 16x16",
8+
"type": "image/x-icon"
9+
}
10+
],
11+
"start_url": ".",
12+
"display": "standalone",
13+
"theme_color": "#000000",
14+
"background_color": "#ffffff"
15+
}

0 commit comments

Comments
 (0)