Technologic101 commited on
Commit
4b65fa0
·
1 Parent(s): df52c42

build: updates README

Browse files
Files changed (1) hide show
  1. README.md +16 -29
README.md CHANGED
@@ -112,40 +112,27 @@ ImagineUI/
112
 
113
  This app is for designers and non-designers who want to be inspired and see examples of good style design.
114
 
115
-
116
  ## Solution
117
 
118
  An agentic RAG application that scrapes designs from CSS Zen Garden and serves the best matches to the user.
119
 
120
- ### Tools
121
 
122
- a: LLM
123
- b: Embedding Model
124
- c: Orchestration
125
- d: Vector Database
126
- e: Monitoring
127
- f: Evaluation
128
- g: User Interface
129
- h: Serving & Inference (optional)
130
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
131
 
132
- # **Data Collection & Dataset Creation**
133
 
134
- ### Dataset Format
135
- ```json
136
- {
137
- "id": "001",
138
- "html_template": "path/to/template.html",
139
- "css_style": "path/to/style.css",
140
- "screenshots": {
141
- "lg": "path/to/desktop.png",
142
- "sm": "path/to/mobile.png"
143
- },
144
- "metadata": {
145
- "description": "A minimalist business template with...",
146
- "category": ["business", "minimalist"],
147
- "accessibility_score": 98,
148
- "color_scheme": ["#ffffff", "#000000", "#4285f4"]
149
- }
150
- }
151
- ```
 
112
 
113
  This app is for designers and non-designers who want to be inspired and see examples of good style design.
114
 
 
115
  ## Solution
116
 
117
  An agentic RAG application that scrapes designs from CSS Zen Garden and serves the best matches to the user.
118
 
 
119
 
120
+ # **Data Collection & Dataset Creation**
 
 
 
 
 
 
 
121
 
122
+ To populate the data, run the notebook in the data_collection folder with a range of design ids. Not all are included in the repository. New data will need to be moved to the src data folder to be accessible to the application.
123
+
124
+ # **Build**
125
+
126
+ uv sync
127
+
128
+ chainlit run src/app.py
129
+
130
+ And you're off!
131
+
132
+ ## Public addresses
133
+
134
+ https://huggingface.co/spaces/Technologic101/imagineui
135
+
136
+ https://github.com/Technologic101/ImagineUI/tree/main
137
 
 
138