Skip to content

psadigh91/PromptEngineerProject

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 

Repository files navigation

PromptEngineerProject

👋 Welcome to Prompt Engineer!

🎯 What This Is

A complete, production-ready AI Prompt Optimization Platform built with:

  • Frontend: React 18 + Vite + Tailwind CSS
  • Backend: Python FastAPI + SQLite
  • Features: Prompt analysis, optimization, library, context upload
  • Deployment: Ready for AWS Amplify, Vercel, Netlify, or Docker

🚀 Quick Navigation

What You Want To Do Read This File
See it live https://staging.d1a9rwz0d7hjvm.amplifyapp.com/
Run it locally QUICKSTART.md
Deploy to Amplify/Vercel DEPLOYMENT-GUIDE.md
Upload to GitHub GITHUB-SETUP.md
Learn about the project PROJECT_SUMMARY.md
Full documentation README.md

⚡ 30-Second Start

Run Locally

# Backend (Terminal 1)
cd backend
python3 -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -r requirements.txt
python main.py

# Frontend (Terminal 2)
cd frontend
npm install
npm run dev

Visit: http://localhost:5173

Deploy to Amplify

cd frontend
npm install
VITE_DEMO_MODE=true npm run build
cd dist
zip -r ~/amplify-deploy.zip .

Upload amplify-deploy.zip to Amplify Console.

Full guide: DEPLOYMENT-GUIDE.md


📂 Project Structure

prompt-engineer-app/
├── frontend/           # React app
│   ├── src/
│   │   ├── components/  # 7 React components
│   │   ├── pages/       # 3 pages (Home, Library, Settings)
│   │   ├── services/    # API + Mock API
│   │   └── utils/       # Constants
│   └── package.json
│
├── backend/           # FastAPI server
│   ├── api/           # API routes (analyze, library, contexts)
│   ├── core/          # Business logic (analyzer, optimizer)
│   └── main.py
│
├── contexts/          # Example context files
│   ├── industries/    # Healthcare, Finance
│   └── solutions/     # Customer Support
│
├── scripts/           # Utility scripts
│   ├── setup.sh       # One-command setup
│   └── start.sh       # Start both services
│
└── docs/             # Documentation (10+ guides)

🎨 Features

Core Features

  • Prompt Analysis - 6-dimension PROMPT framework
  • Interactive Optimization - Step-by-step Q&A
  • Context Upload - Industry/solution-specific customization
  • Prompt Library - Save, search, filter, export
  • Demo Mode - Works without backend (perfect for portfolio!)

Technical Highlights

  • ✅ Beautiful gradient UI design
  • ✅ Fully responsive (mobile, tablet, desktop)
  • ✅ Mock API for frontend-only deployment
  • ✅ Real backend for production use
  • ✅ Complete documentation

🌐 Live Demo

URL: https://staging.d1a9rwz0d7hjvm.amplifyapp.com/

Try it:

  1. Enter a prompt: "Write an email to a customer"
  2. Click "Analyze Prompt"
  3. See analysis results
  4. Answer questions
  5. Get optimized prompt

Demo Mode: Uses mock data, no backend required.


📚 Documentation Files

File Purpose
README.md Main documentation (features, tech stack)
QUICKSTART.md 5-minute local setup
DEPLOYMENT-GUIDE.md Deploy to Amplify/Vercel/Netlify
GITHUB-SETUP.md Upload to GitHub
INSTALL.md Detailed installation (all platforms)
PROJECT_SUMMARY.md Technical architecture
CONTRIBUTING.md How to contribute
00-START-HERE.md Original getting started (legacy)
AWS_AMPLIFY_DEPLOY.md Amplify-specific guide
FRONTEND_COMPLETE.md Frontend component docs

🎯 Choose Your Path

I Want To...

...See it working quickly → Visit: https://staging.d1a9rwz0d7hjvm.amplifyapp.com/

...Run it on my computer → Read: QUICKSTART.md (5 minutes)

...Deploy my own version → Read: DEPLOYMENT-GUIDE.md (Choose platform)

...Upload to GitHub → Read: GITHUB-SETUP.md (10 minutes)

...Understand the code → Read: PROJECT_SUMMARY.md (Technical details)

...Contribute or customize → Read: CONTRIBUTING.md


💡 Key Points

For Portfolio/Demos

  • Demo Mode works perfectly (no backend needed)
  • ✅ Deploy to Amplify in 5 minutes
  • ✅ Free tier sufficient
  • ✅ Professional appearance

For Production

  • ✅ Real backend available (FastAPI + SQLite)
  • ✅ Data persistence
  • ✅ Scalable architecture
  • ✅ Can upgrade to PostgreSQL

For Learning

  • ✅ Clean code structure
  • ✅ Well-documented
  • ✅ Modern tech stack
  • ✅ Best practices applied

🛠️ Tech Stack

Frontend:

  • React 18
  • Vite 5
  • Tailwind CSS 3
  • React Router 6
  • Axios

Backend:

  • Python 3.9+
  • FastAPI
  • SQLAlchemy
  • SQLite (upgradeable to PostgreSQL)

Deployment:

  • AWS Amplify (demo)
  • Vercel / Netlify (alternatives)
  • Heroku / Railway (backend)
  • Docker (self-hosted)

✅ What's Included

  • Complete source code (frontend + backend)
  • 10+ documentation files
  • 4 example context files
  • Setup scripts (one-command install)
  • Mock API (demo mode)
  • Docker support
  • MIT License (free to use)

🎉 You're Ready!

Next steps:

  1. Quick look: Visit the live demo
  2. Run locally: Follow QUICKSTART.md
  3. Deploy your own: Follow DEPLOYMENT-GUIDE.md
  4. Share on GitHub: Follow GITHUB-SETUP.md

🆘 Need Help?


📊 Project Stats

  • Files: ~50 source files
  • Code: ~5,000 lines
  • Documentation: 10 guides
  • Features: 5 major features
  • Tech Stack: 10+ technologies
  • Development Time: Professional quality
  • Status: Production-ready ✅

Built with ❤️ as a portfolio project showcasing full-stack development skills.

Ready to impress at interviews, share on LinkedIn, and deploy for the world to see! 🚀

About

Build better AI prompts with systematic analysis, custom context(s), and a reusable library

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages