Skip to content

START_HERE.md

Latest commit

 

History

History
201 lines (147 loc) · 4.81 KB

START_HERE.md

File metadata and controls

201 lines (147 loc) · 4.81 KB

🎯 SUPER SIMPLE START GUIDE

Choose Your Operating System:

🪟 WINDOWS USERS

The EASIEST Way:

  1. Double-click run_windows.bat
  2. Wait for it to install everything
  3. Browser will show the app at http://localhost:8000
  4. Done! 🎉

Alternative Way:

  1. Open Command Prompt (search "cmd" in Start menu)
  2. Type: cd Handwriting-Recognition-App-03 (your folder location)
  3. Type: pip install -r requirements_fastapi.txt
  4. Type: python start_server.py
  5. Open browser: http://localhost:8000

🍎 MAC USERS

The EASIEST Way:

  1. Open Terminal (press Cmd+Space, type "terminal")
  2. Type: cd (with space at end)
  3. Drag the handwriting-fastapi folder into Terminal window
  4. Press Enter
  5. Type: ./run_mac_linux.sh
  6. Browser will show the app at http://localhost:8000
  7. Done! 🎉

Alternative Way:

  1. Open Terminal
  2. Type: cd Handwriting-Recognition-App-03
  3. Type: pip3 install -r requirements.txt
  4. Type: python3 server.py
  5. Open browser: http://localhost:8000

🐧 LINUX USERS

The EASIEST Way:

  1. Open Terminal
  2. Navigate to folder: cd /Handwriting-Recognition-App-03
  3. Run: ./run_mac_linux.sh
  4. Browser will show the app at http://localhost:8000
  5. Done! 🎉

Alternative Way:

  1. Open Terminal
  2. Type: cd /Handwriting-Recognition-App-03
  3. Type: pip3 install -r requirements.txt
  4. Type: python3 server.py
  5. Open browser: http://localhost:8000

📱 WHAT YOU'LL SEE

When you open http://localhost:8000 you'll see:

┌─────────────────────────────────────────┐
│   ✍️ Handwriting Recognition System     │
│   AI-Powered Digit Recognition          │
├─────────────────────────────────────────┤
│  📊 Dashboard  ✏️ Draw  📁 Upload       │
├─────────────────────────────────────────┤
│                                         │
│  [Draw a digit here and click predict] │
│                                         │
└─────────────────────────────────────────┘

🎮 TRY IT OUT

Option 1: Draw a Digit

  1. Click "✏️ Draw & Predict" tab
  2. Draw a number (0-9) with your mouse
  3. Click "🔍 Predict" button
  4. See the AI's prediction!

Option 2: Upload an Image

  1. Click "📁 Upload Image" tab
  2. Drag & drop an image with a handwritten digit
  3. Get instant prediction!

❓ TROUBLESHOOTING

Problem: "Python not found"

Windows: Install Python from https://www.python.org/downloads/ Mac: Type brew install python3 (if you have Homebrew) Linux: Type sudo apt install python3 python3-pip

Problem: "Permission denied"

Mac/Linux: Type chmod +x run_mac_linux.sh then try again

Problem: "Port already in use"

Someone else is using port 8000. Run this instead:

python server.py --port 8001

Then go to: http://localhost:8001

Problem: "Module not found"

Run the install command again:

pip install -r requirements.txt

🎯 MINIMUM REQUIREMENTS

✅ Python 3.8 or newer ✅ 2GB free disk space ✅ Internet connection (for first-time setup) ✅ Any modern web browser

📞 QUICK HELP

Can't install Python packages? → Try: pip install --user -r requirements_fastapi.txt

Server won't start? → Check the terminal for error messages → Red text = error, read what it says

Need to stop the server? → Press Ctrl+C in the terminal

Want to run it again? → Just run the same command again!

🚀 FASTEST START (One Command)

Windows:

run_windows.bat

Mac/Linux:

./run_mac_linux.sh

That's it! 🎉

✅ SUCCESS CHECKLIST

After running, you should see:

Then:

🎊 YOU'RE DONE!

Now you can:

  • ✏️ Draw digits and get predictions
  • 📁 Upload images
  • 📊 View analytics
  • 🔧 Train your own model
  • 📈 See prediction history

Have fun! 🚀

💡 PRO TIPS

  1. First time? It takes 2-5 minutes to install packages
  2. Second time? Server starts in seconds!
  3. Draw clearly for best predictions
  4. Upload images with clear, large digits
  5. Check /docs for API documentation at http://localhost:8000/docs

Still stuck? Read HOW_TO_RUN.md for detailed instructions!