Skip to content

Commit 61f1e24

Browse files
Update readme.md
1 parent 1078092 commit 61f1e24

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

data-passport-form/readme.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
11

2+
# JSON Schema Form Generator
3+
4+
A lightweight tool that generates web forms from JSON Schema definitions. This tool allows users to create, validate, and collect form submissions based on JSON Schema specifications.
5+
6+
## 🚀 Features
7+
8+
- Dynamically generates forms from JSON Schema
9+
- Supports schema validation according to JSON Schema specification
10+
- Handles nested objects and arrays
11+
- Resolves JSON Schema references recursively
12+
- Form submissions can be downloaded as JSON or CSV
13+
- Converts GitHub URLs to raw GitHub URLs automatically
14+
- Validation respects schema requirements (formats, patterns, etc.)
15+
16+
## 🧩 Usage
17+
18+
1. Enter a JSON Schema URL or paste a schema directly
19+
2. Click **"Fetch Schema"** or **"Generate Form"**
20+
3. Fill out the generated form
21+
4. Submit the form to collect data
22+
5. Download submissions as JSON or CSV
23+
24+
## 🌐 Example URLs
25+
26+
- Raw GitHub URL:
27+
`https://raw.githubusercontent.com/OpenEthicsAI/OEDP/refs/heads/main/schema/oedp.passport.schema.json`
28+
29+
## ⚠️ CORS Handling
30+
31+
When working with external schema URLs, you may encounter **CORS (Cross-Origin Resource Sharing)** restrictions. To work around this:
32+
33+
- Use **raw GitHub URLs** whenever possible (they bypass CORS issues)
34+
- Copy and paste the schema directly into the text area
35+
36+
## 🛠️ Local Development
37+
38+
To run this tool locally:
39+
40+
1. Clone the repository
41+
2. Open the HTML file in a web browser
42+

0 commit comments

Comments
 (0)