BATCH-FILES-README.md•4.23 kB
# Batch File Quick Reference
This directory contains several batch files to make working with the MCP Quoting System easier.
## 🚀 Main Launcher
**`START.bat`** - Interactive menu with all options
- First-time setup
- Start/stop servers
- View data
- Build project
- Open in browser
**Just double-click START.bat to begin!**
---
## 📋 Individual Batch Files
### Setup & Installation
- **`setup.bat`** - First-time setup wizard
- Installs dependencies
- Creates .env file
- Initializes database
- Builds project
### Running the Server
- **`start-dev.bat`** - Development mode with auto-reload
- Best for development
- Automatically restarts on code changes
- Runs on http://localhost:3789
- **`start-prod.bat`** - Production mode
- Optimized for performance
- Requires build first
- Use for actual deployment
- **`stop.bat`** - Stop all server instances
- Kills Node processes on port 3789
- Safe to use even if server isn't running
### Testing & Building
- **`quick-test.bat`** - Automated testing
- Starts server
- Sends test RFQ
- Shows results
- Option to stop or keep running
- **`build.bat`** - Rebuild the project
- Compiles TypeScript
- Creates dist/ folder
- Required before running production mode
### Database Management
- **`view-quotes.bat`** - View historical quotes
- Displays quotes.json contents
- Shows database structure
- **`reset-database.bat`** - Reset to sample data
- Replaces quotes.json with sample-quotes.json
- Use to restore clean test data
- **WARNING: Deletes current data**
---
## 🎯 Quick Start Guide
### First Time Setup
1. Double-click **`START.bat`**
2. Choose option **[1] First Time Setup**
3. Wait for installation to complete
4. Edit `.env` file if you need email functionality
### Daily Development
1. Double-click **`START.bat`**
2. Choose option **[2] Start Development Server**
3. Open http://localhost:3789 in your browser
4. Code changes will auto-reload
### Testing an RFQ
1. Start the server (option 2)
2. Use Postman, curl, or the test client to send RFQs
3. View results in console or browser
### Example curl command:
```bash
curl -X POST http://localhost:3789/mcp/invoke/evaluateRfpAndDraftQuote \
-H "Content-Type: application/json" \
-d "{\"rfp\":{\"rawText\":\"We need 200 pcs of 6061-T6 aluminum, CNC machined, anodize finish, tolerance +/-0.005\",\"qty\":200}}"
```
---
## 🔧 Troubleshooting
### "npm is not recognized"
- Install Node.js from https://nodejs.org/
- Restart your terminal
### Port 3789 already in use
- Run `stop.bat` to kill existing processes
- Or change PORT in .env file
### Build errors
- Delete `node_modules` folder
- Run `setup.bat` again
- Check that TypeScript is installed: `npm list typescript`
### Server won't start
- Check that dependencies are installed
- Run `npm install` manually
- Look for errors in console output
### Database issues
- Run `reset-database.bat` to restore sample data
- Check that `data/` folder exists
- Verify `quotes.json` is valid JSON
---
## 📝 File Locations
- **Batch files**: Root directory (where this README is)
- **Source code**: `src/` folder
- **Database**: `data/quotes.json`
- **Configuration**: `.env` file
- **Built files**: `dist/` folder (after building)
---
## 🆘 Getting Help
If you encounter issues:
1. Check the console output for error messages
2. Look in `server.log` if using quick-test
3. Verify all dependencies are installed
4. Try running `setup.bat` again
5. Check the main README.md for API documentation
---
## 🎨 Customization
### Change Server Port
Edit `.env`:
```
PORT=3789 # Change this number
```
### Add Custom Scripts
Edit `package.json` to add new npm scripts, then create corresponding .bat files.
### Modify Test Data
Edit `data/sample-quotes.json` to add/change test quotes.
---
## ⚡ Power User Tips
- **Quick restart**: Run `stop.bat` then `start-dev.bat`
- **Check if running**: Visit http://localhost:3789/health
- **View logs**: Add `> server.log 2>&1` to batch files
- **Background mode**: Use `start /B` in batch files
- **Multiple terminals**: Run separate instances on different ports
---
**Questions?** Check the main README.md for full documentation.