Skip to content

HusnainRKI/PromptBuddy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 

Repository files navigation

PromptBuddy - Complete Full-Stack Solution

A production-ready Flutter app, web CMS, and REST API for managing and sharing text prompts.

Architecture

This project consists of three main components:

  1. Flutter Mobile App (mobile_app/) - User-facing app for browsing, searching, creating, and sharing prompts
  2. REST API Service (api_service/) - Secure backend service using Node.js, Express, and MySQL
  3. Web CMS (web_cms/) - Admin panel built with React for managing categories and prompts

Quick Start

Prerequisites

  • Flutter SDK (3.x+)
  • Node.js (18+)
  • MySQL (8.0+)
  • Chrome/Edge for web development

1. Database Setup

# Create MySQL database
mysql -u root -p -e "CREATE DATABASE promptbuddy;"

2. API Service

cd api_service
npm install
cp .env.example .env
# Edit .env with your database credentials
npm run migrate
npm run seed
npm start

3. Flutter Mobile App

cd mobile_app
flutter pub get
flutter run

4. Web CMS

cd web_cms
npm install
npm start

Features

Mobile App

  • ✅ Offline-first architecture with sync
  • ✅ Global search with debouncing
  • ✅ Category-based organization
  • ✅ Variable parsing and preview
  • ✅ Native sharing capabilities
  • ✅ Light/dark themes
  • ✅ Import/export JSON
  • ✅ Accessibility support

Web CMS

  • ✅ Role-based access control
  • ✅ Drag-and-drop category reordering
  • ✅ Live variable detection
  • ✅ Bulk operations
  • ✅ Import/export with validation
  • ✅ Audit trail

API Service

  • ✅ JWT authentication
  • ✅ Rate limiting and security
  • ✅ Full-text search
  • ✅ Conflict resolution
  • ✅ Comprehensive validation
  • ✅ API documentation

Project Structure

PromptBuddy/
├── mobile_app/           # Flutter application
├── api_service/          # Node.js REST API
├── web_cms/             # React admin panel
├── docs/                # Documentation
└── sample_data/         # Sample prompts and categories

Sample Data

The system comes with three default categories:

  • Photo Editing - Prompts for image editing and enhancement
  • Code - Programming and development prompts
  • Social Media - Content creation for social platforms

Documentation

License

MIT License - see LICENSE for details.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors