Skip to content

GowthamCK/narrativeFlow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

NarrativeFlow

NarrativeFlow is an interactive AI story co-writer application designed to help authors craft compelling narratives. It features an adaptive AI that collaborates with you, offering real-time suggestions, scene visualizations, and stylistic coherence.

NarrativeFlow Dashboard Placeholder

πŸš€ Features

  • Adaptive Co-Writing: A chat-like interface where you and the AI take turns writing. The AI adapts to your selected genre, tone, and style.
  • Parametric Controls: Fine-tune your story's Pacing, Detail Level, and Tone in real-time using the editor's control panel.
  • Scene Visualization: (Mockup) Visualize your current scene with AI-generated imagery.
  • Story Setup Wizard: A comprehensive intake form to define your story's Premise, Genre (Fantasy, Sci-Fi, etc.), and POV.
  • Modern UI/UX:
    • Fully responsive design for Mobile, Tablet, and Desktop.
    • Dark/Light Mode support (System synced).
    • Professional, focused writing environment.
  • User Management:
    • Secure Login & Signup pages.
    • User Profile dashboard with writing statistics.

πŸ› οΈ Tech Stack

  • Frontend: React 18, TypeScript, Vite
  • Styling: Tailwind CSS, PostCSS, CSS Variables (Theming)
  • Animations: Framer Motion
  • Routing: React Router DOM (v6+)
  • Icons: Lucide React

πŸ“¦ Installation

  1. Clone the repository (if applicable) or navigate to the project directory.

  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev
  4. Open in Browser: Visit http://localhost:5173 to start writing.

πŸ“‚ Project Structure

src/
β”œβ”€β”€ components/         # Reusable UI components (Button, Input, Slider, etc.)
β”œβ”€β”€ layouts/            # Page layouts (MainLayout)
β”œβ”€β”€ lib/                # Utilities (tailwind-merge, clsx)
β”œβ”€β”€ pages/              # Application Pages
β”‚   β”œβ”€β”€ Home.tsx        # Landing Page
β”‚   β”œβ”€β”€ Login.tsx       # Sign In
β”‚   β”œβ”€β”€ Signup.tsx      # Registration
β”‚   β”œβ”€β”€ StorySetup.tsx  # Configuration Wizard
β”‚   β”œβ”€β”€ StoryEditor.tsx # Main Co-Writing Interface
β”‚   └── Profile.tsx     # User Dashboard
β”œβ”€β”€ types/              # TypeScript definitions
β”œβ”€β”€ App.tsx             # Main Router configuration
└── index.css           # Global Styles & Theme Variables

🎨 Theming

The application uses CSS variables for theming, allowing for accurate color mapping in both Light and Dark modes.

  • Dark Mode: Default for a "Writer's Night Mode" feel.
  • Light Mode: Accessible high-contrast alternative.
  • System: Syncs with your OS settings.

Toggle the theme using the icons in the top navigation bar.

🀝 Contributing

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

Built with ❀️ for Storytellers.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors