Skip to content

onosejoor/TaleGenie

Repository files navigation

📖✨ TaleGenie: Your AI-Powered Story Weaver 🚀

Unleash your imagination with TaleGenie, a Next.js application that crafts captivating stories using the power of AI. Whether you're looking to explore new worlds or bring your own ideas to life, TaleGenie makes storytelling simple and fun!

⚙️ Installation

Get started with TaleGenie in just a few easy steps:

  • Clone the Repository:

    git clone https://github.com/onosejoor/TaleGenie.git
    cd TaleGenie
  • Install Dependencies:

    bun install
  • Set Up Environment Variables:

    Create a .env.local then check the env.local for the env to put

  • Run the Application:

    bun run dev

💻 Usage

Running the Development Server

To start the development server, use the following command:

bun run dev

This will launch the application, and you can view it in your browser at http://localhost:3000.

Creating Stories

  1. Navigate to the /create route to start generating stories.
  2. Enter a prompt and select a genre.
  3. Click the "Generate" button to let TaleGenie weave its magic!
✨ Detailed Usage Instructions

Authentication

Sign up or sign in to access personalized features.

Generating Stories

  • Access the /create route for story generation.
  • Provide a detailed prompt and choose a genre.
  • Click "Generate" and watch your story unfold.

Exploring Stories

  • Visit the /stories route to discover stories from other users.
  • Use the search bar to find stories based on keywords.

Managing Your Profile

  • Update your profile information in the /settings route.
  • View your created stories on your profile page.

✨ Features

  • AI-Powered Story Generation 🤖: Let our AI weave captivating stories from your prompts.
  • User Authentication 🔐: Secure sign-up and sign-in options with Google and email.
  • Remote Image Integration 🖼️: Support for remote images from Cloudinary, Google, and more.
  • Theme Customization 🎨: Toggle between light and dark themes for a personalized experience.
  • Dynamic Loading ⏳: Smooth transitions with loading states for enhanced user experience.
  • Username and Profile Management 👤: Create and manage your unique profile with ease.
  • Responsive Design 📱: Enjoy a seamless experience on any device.

🛠️ Technologies Used

Technology Description
Next.js (TypeScript) A React framework for building modern web applications.
React A JavaScript library for building user interfaces.
Tailwind CSS A utility-first CSS framework for rapid UI development.
NextAuth.js Authentication library for Next.js applications.
Mongoose MongoDB object modeling tool designed to work in an asynchronous environment.
Google Gemini AI For story and image generation.
Swr A React Hooks library for data fetching.
Zod A TypeScript-first schema declaration and validation library.
Vercel Cloud platform for static sites and serverless functions.
@ai-sdk/google Google AI SDK
@pollinations/react For Image Generation AI

🤝 Contributing

We welcome contributions to TaleGenie! Here's how you can help:

  • 🐛 Report Bugs: Submit detailed bug reports to help us improve the application.
  • 💡 Suggest Features: Share your ideas and suggestions for new features and enhancements.
  • 💻 Submit Pull Requests: Contribute code fixes, improvements, or new features by following our contributing guidelines.
  • 📝 Improve Documentation: Help us make the documentation more clear and helpful.
  • Follow Code of Conduct: Please follow our code of conduct during contribution.

📜 License

This project is licensed under the MIT License.

🧑‍💻 Author


Readme was generated by Dokugen

About

an AI story generator, powered by gemini

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages