GoogleML Project

AI-powered story generation and image creation project using OpenAI and other models. https://www.notion.so/Google-ML-Project-21b8730df042801c9977f8654cf32c48

Project Structure

GoogleML/
├── backend/                 # FastAPI Backend
│   ├── app/
│   │   ├── api/            # API endpoints
│   │   │   └── v1/         # API version 1
│   │   ├── core/           # Core configurations
│   │   ├── db/             # Database connections
│   │   ├── models/         # Data models
│   │   ├── services/       # Business logic
│   │   └── utils/          # Utility functions
│   ├── images/             # Generated images storage
│   ├── requirements.txt    # Python dependencies
│   └── run.sh             # Backend startup script
│
├── frontend/               # React Frontend
│   ├── public/            # Static files
│   ├── src/               # Source code
│   ├── package.json       # Node dependencies
│   └── tsconfig.json      # TypeScript configuration
│
└── ml/                    # Machine Learning
    ├── data/              # Dataset storage
    ├── inference/         # Model inference
    └── training/          # Model training

Prerequisites

• Python 3.8+
• Node.js 16+
• MongoDB
• OpenAI API Key

Setup Instructions

Backend Setup

1. Create and activate virtual environment:

cd backend
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

2. Install dependencies:

pip install -r requirements.txt

3. Create .env file in backend directory:

MONGODB_URL=mongodb://localhost:27017
OPENAI_API_KEY=your_api_key_here

4. Run the backend:

./run.sh  # On Windows: run.sh
# Or alternatively:
uvicorn app.main:app --reload

Frontend Setup

1. Install dependencies:

cd frontend
npm install

2. Create .env file in frontend directory:

REACT_APP_API_URL=http://localhost:8000

3. Run the frontend:

npm start

The application will be available at:

• Frontend: http://localhost:3000
• Backend API: http://localhost:8000
• API Documentation: http://localhost:8000/docs

API Documentation

The API documentation is available at /docs endpoint when the backend server is running. It provides detailed information about all available endpoints and their usage.

Features

• Story Generation using OpenAI GPT models
• Image Generation for stories
• Story and Image Management
• Interactive User Interface