Skip to content

sarojit049/GroqTales

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

397 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

GroqTales

AI-Powered Web3 Storytelling Platform

Create, share, and own AI-generated stories and comics as NFTs on the Monad blockchain.

Version Production Deployment Preview Deployments CI Status Last Commit Commit Activity Open Issues Open PRs License Active Contributions Welcome Website Contact Us Discord

SWOC'26 GSSOC'25 FOSS Hack LGM-SOC MLH HackinCodes cWoc Indie Hub Open Source Community

Animated Divider


What is GroqTales?

GroqTales is an open-source, AI-powered Web3 storytelling platform. Writers and artists can generate immersive narratives or comic-style stories using Groq AI, then mint and trade them as NFTs on the Monad blockchain. With a focus on ownership, authenticity, and community, GroqTales bridges the world of creative writing, generative AI, and decentralized technology.


Features

  • AI-Driven Story & Comic Generation Use Groq AI to generate stories or comic panel outlines by specifying title, genre, setting, characters, and themes. Both text and comic formats are supported.
  • Extensive Story Customization (70+ Parameters) Fine-tune every aspect of your story with comprehensive customization across 9 categories:
    • Characters: Name, count, traits, age, background, protagonist type
    • Plot & Structure: Type, conflict, arc, pacing, ending, plot twists
    • Setting & World: Time period, location, world-building depth, atmosphere
    • Writing Style & Tone: Voice, tone, style, reading level, mood, dialogue percentage, description detail
    • Themes & Messages: Primary/secondary themes, moral complexity, social commentary
    • Content Controls: Violence, romance, language levels, mature content warnings
    • Advanced Options: Chapters, foreshadowing, symbolism, multiple POVs
    • Inspiration & References: Similar works, inspired by, tropes to avoid/include
    • Technical Parameters: AI creativity slider, model selection
  • NFT Minting on Monad Blockchain Seamlessly mint your stories as NFTs on Monad (Testnet live, Mainnet coming soon). Each NFT proves authenticity, ownership, and collectibility.
  • Community Gallery Publish your stories publicly, browse the gallery, and interact with other creators. Stories can be shared freely or as NFTs.
  • Progressive Disclosure UI Clean, accordion-based interface with 9 collapsible sections. Keeps simple tasks simple while offering advanced options when needed. Only prompt is required—everything else is optional!
  • Wallet Integration Connect with MetaMask, WalletConnect, or Ledger for secure publishing and minting. Wallet is required for NFT actions.
  • Real-Time Story Streaming Watch your story unfold in real-time as Groq AI generates each segment.
  • Mobile-Friendly & Responsive UI Built with modern web technologies for a seamless experience on any device.
  • Extensible & Open Source Modular codebase with clear separation of frontend, backend, and smart contract logic. Contributions are welcome!

Tech Stack

  • Frontend: Next.js, React, TailwindCSS, shadcn/ui
  • Backend: Node.js, API Routes
  • AI: Groq API (story generation), Unsplash API (optional visuals)
  • Blockchain: Monad SDK, Solidity Smart Contracts
  • Database: MongoDB
  • Hosting: Vercel

Quick Start

git clone https://github.com/IndieHub25/GroqTales
cd GroqTales
npm install
cp .env.example .env.local
# Add GROQ_API_KEY, UNSPLASH key, Monad network if needed
npm run dev
  1. Visit http://localhost:3000
  2. Connect your wallet (optional; required for minting/publishing)
  3. Generate your story → Publish or Mint as NFT

See the Wiki for configuration, environment variables, and deployment details.


🛠️ Environment Configuration

To run this project locally, you must set up your environment variables. Create a file named .env.local in the root directory and populate it with the following keys:

.env.local Setup

Variable Requirement Description
GROQ_API_KEY Required Powers the AI story generation engine via Groq LPU.
MONAD_RPC_URL Required The RPC endpoint for interacting with the Monad Testnet.
MONGODB_URI Required Connection string for the database storing user profiles and drafts.
UNSPLASH_API_KEY Optional API key used for fetching high-quality cover images for stories.
NEXT_PUBLIC_CONTRACT_ADDR Required The smart contract address for the deployed NFT collection.

🔑 How to get these keys:

  1. Groq API: Generate a key at Groq Cloud Console.
  2. Monad RPC: Use the official Monad Testnet docs to find the latest RPC URL.
  3. MongoDB: Create a free cluster at MongoDB Atlas.
  4. Unsplash: Register an application on the Unsplash Developer Portal.

Warning

Never commit your .env.local file to version control. Ensure it is listed in your .gitignore to prevent leaking sensitive API keys.


📜 Smart Contracts

GroqTales utilizes Solidity-based smart contracts for NFT minting and ownership management. We prefer Hardhat for local development, compilation, and testing.

🛠️ Contract Workflow

  • Contract Location: /contracts/
  • Compile: npx hardhat compile
  • Local Test: npx hardhat test
  • Network: Monad Testnet (ChainID: 10143)

Warning

Safety Disclaimer: GroqTales currently operates exclusively on the Monad Testnet. Do not send real funds (ETH or Mainnet MON) to these contract addresses. Always use a dedicated developer/faucet-funded wallet for testing.


🏗️ System Architecture

GroqTales follows a decoupled architecture ensuring high-speed AI inference and decentralized ownership.

graph TD
    A[User Interface - Next.js] -->|Prompt| B[Backend API - Node.js]
    B -->|Inference Request| C[Groq AI LPU Engine]
    C -->|Streamed Story| B
    B -->|Metadata| D[MongoDB]
    B -->|IPFS Upload| E[Story/Image Data]
    A -->|Mint NFT| F[Monad Testnet Blockchain]
    F --- G[Smart Contracts - Solidity]
Loading

For Developers

  • Folder Structure:

    • /app – Next.js application (pages, UI, routes)
    • /components – Reusable React components
    • /contracts – Solidity smart contracts for NFT minting
    • /lib – Utility functions and API integrations
    • /public – Static assets
    • /test and /tests – Test scripts and sample data
    • /scripts – Automation and deployment scripts
  • Environment Variables:

    • GROQ_API_KEY – Your Groq AI API key
    • UNSPLASH_API_KEY – (Optional) for placeholder visuals
    • MONAD_RPC_URL – Monad blockchain RPC endpoint
  • Smart Contract Deployment:

    • Contracts are written in Solidity and can be deployed to Monad Testnet/Mainnet.
    • See /contracts and /scripts for deployment instructions.
  • Extending AI Models:

    • AI logic is modular—add support for new models or prompt types in /lib and /components.
  • Testing:

    • Frontend: Use Jest/React Testing Library.
    • Smart Contracts: Use Hardhat/Foundry for Solidity tests.
  • Contributions:


🤝 Contributing

GroqTales is community-powered! We welcome all contributions—whether you're a developer, designer, writer, or blockchain enthusiast.

How You Can Help:

  • Tackle issues labeled good first issue (great for newcomers)
  • Enhance story-generation logic, outlines, or UI design
  • Add support for new AI models or blockchains
  • Improve UX (dark mode, mobile layout, galleries)
  • Optimize NFT metadata or IPFS workflows
  • Write or improve documentation and tests

What’s in It for You:

  • Build your open-source portfolio
  • Feature your work in the contributors section
  • Community recognition and GitHub Sponsors eligibility

See CONTRIBUTING.md for guidelines.


Roadmap

  • AI visuals: Integrate Stable Diffusion/DALL·E for comic panels
  • Multilingual story generation
  • Native marketplace for story NFTs
  • Enhanced wallet security & decentralized data storage
  • Mobile app support
  • More blockchain integrations

Contributors

We value every contribution! Please read our CONTRIBUTORS.md file before making your first contribution to understand our guidelines and recognition process.

Project Contributors

Contributors

Thanks to these amazing people for making GroqTales better!


Documentation & Architecture

Core Documentation

  • Architecture Overview: ARCHITECTURE.md - Comprehensive system design and technical architecture
  • Project Wiki: GitHub Wiki - Detailed guides and documentation
  • API Documentation: Wiki/API - Backend API reference
  • Smart Contracts: Wiki/Blockchain - Contract documentation

System Architecture

Development Resources


Resources


License

Released under the MIT License.


Security

For vulnerabilities or security-related issues, please refer to SECURITY.md.


Note

GroqTales currently operates on Monad Testnet for NFT minting. Mainnet support coming soon—stay tuned!


Support the project and share it with others.

About

GroqTales is an open-source platform that uses AI to generate stories and comics, which you can mint and own as NFTs on the Monad blockchain. Join a creative community blending storytelling, generative AI, and Web3 technology.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 84.0%
  • JavaScript 11.9%
  • Python 2.0%
  • CSS 1.2%
  • Solidity 0.7%
  • Shell 0.2%