8000 GitHub - Aditya31032006/inkloom Β· GitHub
[go: up one dir, main page]

Skip to content
Aditya31032006Public

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

Β 

History

2 Commits

Folders and files

Repository files navigation

Inkloom - AI-Powered Brand Intelligence Platform

Transform rough ideas into coherent, launch-ready brand systems through a structured 11-stage AI workflow.

🎯 Problem

Founders, creators, and teams often start with a rough idea but struggle to translate it into a cohesive brand strategy. They face:

  • Unclear positioning and differentiation
  • Generic naming and messaging
  • Inconsistent visual identity
  • No systematic approach to brand development
  • Expensive agency fees for early-stage work

πŸ’‘ Solution

Inkloom is an AI-powered brand intelligence platform that guides users through a structured 11-stage workflow, transforming a rough idea into a complete brand kit with positioning, naming, visual identity, messaging, and launch content.

✨ Features

11-Stage AI Workflow

  1. Discover - AI interview to deeply understand your idea
  2. Position - Define category, audience, value proposition, differentiation
  3. Personality - Select 4-5 brand traits with rationale
  4. Naming - Generate 15+ names across multiple territories
  5. Messaging - Craft taglines, pitches, and message hierarchy
  6. Visual - Define colors, typography, logo concept, imagery style
  7. Critique - AI critic detects clichΓ©s, weaknesses, contradictions
  8. Consistency - Cross-check all elements for alignment
  9. Voice - Define brand voice and write sample copy
  10. Launch - Generate complete launch content kit
  11. Brand Kit - Polished, exportable final deliverable

Key Capabilities

  • Human-in-the-loop: Review, edit, regenerate, or accept at every stage
  • Structured context: Each stage receives structured data from previous stages
  • Decision history: Track every brand decision with timestamps
  • Export/Download: Markdown and text export of brand kit
  • Responsive design: Works on desktop and mobile
  • JWT Authentication: Secure user accounts with protected routes

πŸ—οΈ Architecture

project-root/
β”œβ”€β”€ frontend/                 # React + Vite + Tailwind CSS
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ components/       # Reusable UI components
β”‚   β”‚   β”œβ”€β”€ pages/            # Page components
β”‚   β”‚   β”œβ”€β”€ layouts/          # Layout components
β”‚   β”‚   β”œβ”€β”€ services/         # API service layer
β”‚   β”‚   β”œβ”€β”€ hooks/            # Custom React hooks
β”‚   β”‚   β”œβ”€β”€ context/          # React context providers
β”‚   β”‚   β”œβ”€β”€ utils/            # Utility functions
β”‚   β”‚   β”œβ”€β”€ App.jsx           # Main app with routing
β”‚   β”‚   β”œβ”€β”€ main.jsx          # Entry point
β”‚   β”‚   └── index.css         # Global styles + Tailwind
β”‚   └── package.json
β”‚
β”œβ”€β”€ backend/                    # Node.js + Express + Prisma
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ config/           # Configuration management
β”‚   β”‚   β”œβ”€β”€ controllers/      # Request handlers
β”‚   β”‚   β”œβ”€β”€ middleware/       # Express middleware
β”‚   β”‚   β”œβ”€β”€ routes/           # API route definitions
β”‚   β”‚   β”œβ”€β”€ services/         # Business logic & AI services
β”‚   β”‚   β”‚   └── ai/           # Modular AI services per stage
β”‚   β”‚   β”œβ”€β”€ utils/            # Utility functions
β”‚   β”‚   β”œβ”€β”€ validators/       # Zod validation schemas
β”‚   β”‚   β”œβ”€β”€ app.js            # Express app setup
β”‚   β”‚   └── server.js         # Server entry point
β”‚   β”œβ”€β”€ prisma/
β”‚   β”‚   └── schema.prisma     # Database schema
β”‚   └── package.json
β”‚
└── README.md

πŸ€– AI Workflow

ROUGH IDEA
    ↓
DISCOVERY (AI Interview β†’ Structured Profile)
    ↓
POSITIONING (Category, Audience, Value Prop, Differentiator)
    ↓
PERSONALITY (4-5 Traits + Traits to Avoid)
    ↓
NAMING (15+ Names across 4-5 Territories β†’ Select ONE)
    ↓
MESSAGING (Taglines, Pitches, Hierarchy β†’ Select Tagline)
    ↓
VISUAL (Colors, Typography, Logo, Imagery)
    ↓
CRITIQUE (Detect Issues β†’ Apply/Ignore/Edit)
    ↓
CONSISTENCY (Cross-check All Elements β†’ Apply Fixes)
    ↓
VOICE (Characteristics, Tone, Sample Copy)
    ↓
LAUNCH (Landing Page, Social Posts, Founder Pitch)
    ↓
FINAL BRAND KIT (Complete Exportable Deliverable)

Each stage:

  • Receives structured context from previous stages
  • Generates structured JSON via LLM
  • Allows user to edit, regenerate, or accept
  • Saves approved decisions to database
  • Passes approved data to next stage

πŸ› οΈ Tech Stack

Frontend

  • React 18 - UI framework
  • Vite - Build tool & dev server
  • React Router v6 - Client-side routing
  • Tailwind CSS - Utility-first styling
  • Lucide React - Icon library
  • Axios - HTTP client
  • React Hot Toast - Notifications
  • date-fns - Date formatting
  • clsx + tailwind-merge - Class name utilities

Backend

  • Node.js - Runtime
  • Express.js - Web framework
  • Prisma ORM - Database ORM
  • PostgreSQL - Primary database
  • JWT - Authentication
  • bcryptjs - Password hashing
  • Zod - Input validation
  • OpenAI SDK - LLM integration (compatible with OpenAI API)

AI Services (Modular)

Each stage has a dedicated service:

  • discoveryService.js - AI interview & profile generation
  • positioningService.js - Positioning strategy
  • personalityService.js - Brand personality traits
  • namingService.js - Name generation across territories
  • messagingService.js - Messaging framework
  • visualService.js - Visual identity direction
  • criticService.js - AI brand critic
  • consistencyService.js - Consistency guardian
  • voiceService.js - Brand voice & copy
  • launchService.js - Launch content kit

πŸ—„οΈ Database Schema

Core Models

  • User - Authentication (id, name, email, passwordHash)
  • Project - Brand project (name, roughIdea, status, currentStage)
  • Discovery - Core problem, audiences, needs, goals, constraints
  • Positioning - Category, audience, value prop, differentiator, statement
  • BrandPersonality - Traits (with why/how), traits to avoid
  • Naming - Territories with names, selected name + rationale
  • Messaging - Taglines, pitches, hierarchy, selected tagline
  • VisualDirection - Logo, typography, colors, imagery style
  • Critique - Issues with severity, problem, suggestion, alternative
  • ConsistencyCheck - Cross-element checks, overall score
  • BrandVoice - Characteristics, tone, vocabulary, sample copy
  • LaunchKit - Landing page, social posts, founder pitch
  • BrandKit - Final deliverable marker
  • DecisionHistory - Audit trail of all decisions

Relationships

User 1β”€β”€βˆž Project
Project 1──1 Discovery
Project 1──1 Positioning
Project 1──1 BrandPersonality
Project 1──1 Naming
Project 1──1 Messaging
Project 1──1 VisualDirection
Project 1──1 Critique
Project 1──1 ConsistencyCheck
Project 1──1 BrandVoice
Project 1──1 LaunchKit
Project 1──1 BrandKit
Project 1β”€β”€βˆž DecisionHistory

πŸ”Œ API Documentation

Authentication

Method Endpoint Description
POST /api/auth/register Register new user
POST /api/auth/login Login user
GET /api/auth/me Get current user
POST /api/auth/logout Logout (client-side)

Projects

Method Endpoint Description
GET /api/projects List user's projects
POST /api/projects Create new project
GET /api/projects/:id Get project with all stages
PUT /api/projects/:id Update project
DELETE /api/projects/:id Delete project

Workflow Stages

Method Endpoint Description
POST /api/projects/:id/discovery/interview AI interview questions
POST /api/projects/:id/discovery/generate Generate discovery profile
POST /api/projects/:id/discovery Save discovery profile
POST /api/projects/:id/positioning/generate Generate positioning
POST /api/projects/:id/positioning Save positioning
POST /api/projects/:id/personality/generate Generate personality
POST /api/projects/:id/personality Save personality
POST /api/projects/:id/naming/generate Generate names
POST /api/projects/:id/naming Save selected name
POST /api/projects/:id/messaging/generate Generate messaging
POST /api/projects/:id/messaging Save messaging
POST /api/projects/:id/visual/generate Generate visual direction
POST /api/projects/:id/visual Save visual direction
POST /api/projects/:id/critique/generate Generate critique
POST /api/projects/:id/critique Save critique
POST /api/projects/:id/critique/apply Apply critique action
POST /api/projects/:id/consistency/generate Generate consistency check
POST /api/projects/:id/consistency Save consistency
POST /api/projects/:id/consistency/apply Apply consistency fix
POST /api/projects/:id/voice/generate Generate brand voice
POST /api/projects/:id/voice Save brand voice
POST /api/projects/:id/launch/generate Generate launch kit
POST /api/projects/:id/launch Save launch kit
GET /api/projects/:id/brand-kit Get complete brand kit

πŸš€ Getting Started

Prerequisites

  • Node.js 18+
  • PostgreSQL 14+
  • npm or yarn

Environment Setup

  1. Clone and navigate to project
cd INKLOOM
  1. Backend setup
cd backend
cp .env.example .env
# Edit .env with your configuration

Required environment variables in backend/.env:

# Database
DATABASE_URL="postgresql://USERNAME:PASSWORD@localhost:5432/brand_intelligence"

# JWT
JWT_SECRET="your_super_secret_jwt_key_change_in_production"
JWT_EXPIRES_IN="7d"

# AI Configuration (OpenAI compatible)
AI_API_KEY="your_ai_api_key"
AI_MODEL="gpt-4o-mini"
AI_BASE_URL="https://api.openai.com/v1"

# Server
PORT=5000
FRONTEND_URL="http://localhost:5173"
NODE_ENV="development"
  1. Install backend dependencies
npm install
  1. Set up database
# Generate Prisma client
npm run prisma:generate

# Run migrations
npm run prisma:migrate

# Or push schema directly (development)
npm run prisma:push
  1. Frontend setup
cd ../frontend
npm install

Running the Application

Terminal 1 - Backend:

cd backend
npm run dev
# Server runs on http://localhost:5000

Terminal 2 - Frontend:

cd frontend
npm run dev
# Frontend runs on http://localhost:5173

Database Commands

# Generate Prisma client after schema changes
npm run prisma:generate

# Create and run migration
npm run prisma:migrate

# Push schema without migration (dev only)
npm run prisma:push

# Open Prisma Studio (database GUI)
npm run prisma:studio

# Seed database (if seed script exists)
npm run prisma:seed

πŸ” Security

  • Password Hashing: bcrypt with 12 rounds
  • JWT Authentication: Secure tokens with expiration
  • Protected Routes: All project APIs require authentication
  • Authorization: Users can only access their own projects
  • Input Validation: Zod schemas on all endpoints
  • Parameterized Queries: Prisma prevents SQL injection
  • CORS: Configured for frontend origin only
  • Environment Variables: All secrets in .env (never committed)
  • No Frontend Secrets: AI API key only on backend

πŸ§ͺ Testing

# Backend tests (when implemented)
cd backend
npm test

# Frontend tests (when implemented)
cd frontend
npm test

πŸ“¦ Deployment

Backend

  1. Set NODE_ENV=production
  2. Use strong JWT_SECRET
  3. Configure production DATABASE_URL
  4. Set AI_API_KEY for production
  5. Run npm run prisma:migrate deploy
  6. Start with npm start

Frontend

  1. Build: npm run build
  2. Serve dist/ folder with nginx, Vercel, Netlify, etc.
  3. Configure API proxy or set VITE_API_URL

Docker (Optional)

# Backend Dockerfile
FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm ci --
COPY . .
RUN npx prisma generate
EXPOSE 5000
CMD ["npm", "start"]

🎨 UI/UX Highlights

  • Modern SaaS Design: Clean, professional, hackathon-ready
  • Responsive Layout: Mobile-first with sidebar navigation
  • Progress Indicators: Visual stage completion tracking
  • Loading States: Skeletons and spinners for AI operations
  • Toast Notifications: Success/error feedback
  • Accessible: Semantic HTML, ARIA labels, keyboard navigation
  • Color System: Brand + Ink color palettes with dark mode support

πŸ“ AI Architecture Details

Structured JSON Responses

All AI services return validated JSON with:

  • Strict schema definitions
  • Automatic parsing with fallback strategies
  • Retry logic for failed requests
  • Error handling for malformed responses

Context Passing

Each stage receives exactly what it needs:

  • Naming: Discovery + Positioning + Personality
  • Critique: Complete brand system so far
  • Consistency: All approved brand elements
  • Launch: Final approved brand system

AI Providers

Compatible with any OpenAI-compatible API:

  • OpenAI (GPT-4o, GPT-4o-mini)
  • Anthropic (via proxy)
  • Local models (Ollama, vLLM)
  • Azure OpenAI

🀝 Contributing

  1. Fork the repository
  2. Create feature branch: git checkout -b feature/amazing-feature
  3. Commit changes: git commit -m 'Add amazing feature'
  4. Push to branch: git push origin feature/amazing-feature
  5. Open a Pull Request

πŸ“„ License

MIT License - Built for the Inkloom Hackathon

πŸ™ Acknowledgments

  • Built for the Inkloom Hackathon
  • Inspired by brand strategy frameworks
  • Powered by modern AI and web technologies

Ready to build your brand? Run the application and start transforming your ideas into memorable brands!

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0