Project Info
Welcome to VEIL!
This file will help you and give you instructions on how to seamlessly run our product Please Make sure you meet the following requirements:
Requirements
- Node.js (v16 or higher)
- Ghostscript (for PDF processing)
- (Optional) BrightData API Key
Setup
Step 1: Install Ghostscript
macOS:
brew install ghostscript
gs --version # Verify it's installed
Linux:
sudo apt-get install ghostscript
gs --version # Verify it's installed
Windows:
- Download from https://ghostscript.com/releases/gsdnld.html
- After install, run
gs --versionin Command Prompt to verify
Step 2: Install Node dependencies
cd Veil-2 # Make sure you're in the project folder
npm install
Step 3: Add your API keys
Create a file named .env in the project root folder:
# Required for sensitive data detection
-SIM_API_KEY=your_sim_api_key_here
# Optional: For B2B PDF scraping
-BRIGHTDATA_API_KEY=your_brightdata_api_key_here
-UNLOCKER_ZONE=unlocker
Step 4: Run the app
Terminal 1 - Backend:
node server.js
Terminal 2 - Frontend:
npm run dev
Usage
Open http://localhost:5173 in your browser
#NOTE: if you want to run our MCP, there are more instructions: #MCP Setup: #Additional Requirements
Installation
Prerequisites
- Node.js 16+ and npm
- Claude Desktop app
- SIM API key (get from https://www.sim.ai)
Setup
-
Install dependencies:
cd /Users/spartan/calhacks/veil/mcp-veil-server npm install -
Set your SIM API key:
export SIM_API_KEY=your_sim_api_key_hereOr add it to your shell profile (
~/.zshrcor~/.bashrc):echo 'export SIM_API_KEY=your_sim_api_key_here' >> ~/.zshrc source ~/.zshrc -
Build the project:
npm run build
Connect to Claude Desktop
-
Open your Claude Desktop configuration file:
- Mac:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%AppData%\Claude\claude_desktop_config.json
- Mac:
-
Add the Veil server configuration:
{ "mcpServers": { "veil-search": { "command": "node", "args": [ "/Users/spartan/calhacks/veil/mcp-veil-server/build/index.js" ], "env": { "SIM_API_KEY": "your_sim_api_key_here" } } } }Important: Replace
your_sim_api_key_herewith your actual SIM API key. -
Restart Claude Desktop
Analysis
View
Metric
- 9
- 7
- 3
Figures cover GitHub contributors during the hackathon window. A co-authored commit counts in full for each author, so per-member totals add up to more than the whole-team figures.
Technology
- CSSIn code
- ExpressIn code
- HTMLIn code
- JavaScriptIn code
- LangChainIn code
- PythonIn code
- ReactIn code
- TypeScriptIn code
8 of 8 appear in the indexed code.
AI coding agents
No AI coding agent signals were found in this repository.
Detected from committed agent config files and commit authorship. Absence of a signal is not proof an agent was unused.
Codebase size
Source size
4.7 MB
Source files
26
Counts recognized source files only; vendored directories, binaries and lockfiles are excluded, so this is smaller than the repository on disk.
Repository
Csukirth/Veil
43 files · 45.3 MB · @ f510688
Structure
Interface
1 file · 2%Screens, components and styles rendered to the user.
Application logic
17 files · 40%Domain rules, services and shared utilities.
Data & schema
2 files · 5%Schema definitions, migrations and data access.
Supporting
Layers are inferred from where files sit in the tree, not from reading the code. A project that names its directories unconventionally will read oddly here — open the file browser to check anything the diagram implies.
Languages
- JavaScript98%
- Markdown1%
- CSS1%
- TypeScript0%
- Python0%
- HTML0%
Share of indexed source by file size. Binary and vendored files are excluded.
Dependencies
package.json
npm · 29- @langchain/core
- @langchain/mcp-adapters
- @tesseract.js-data/eng
- audit
- canvas
- dotenv
- express
- formdata-node
- framer-motion
- i
- lucide-react
- node-fetch
- npm
- onnxruntime-node
- pdf-lib
- pdfjs-dist
- react
- react-dom
- +11 more
mcp-veil-server/package.json
npm · 8- @modelcontextprotocol/sdk
- cheerio
- node-fetch
- turndown
- zod
- +3 more
Declared in the repository’s manifests at the indexed commit. A declared package is not proof it is used, and runtime dependencies are listed first.
This project’s features have not been analysed yet.
Export this project's context (description, README, evidence, key source files) to chat with an AI agent elsewhere.