Skip to content

YGNTECHSTARTUP/imaginify

Repository files navigation

Sure! Here is the full content properly formatted in markdown:

# Imaginify

Imaginify is a web application that leverages AI to generate images based on user prompts. It uses Hugging Face models for AI image generation and Clerk for user authentication.

## Table of Contents

- [Features](#features)
- [Tech Stack](#tech-stack)
- [Installation](#installation)
- [Usage](#usage)
- [Environment Variables](#environment-variables)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Features

- User authentication with Clerk
- AI-powered image generation using Hugging Face models
- Interactive chat interface for prompt input
- Responsive design with Tailwind CSS

## Tech Stack

- **Frontend**: Next.js, React
- **Styling**: Tailwind CSS
- **Authentication**: Clerk
- **AI Integration**: Hugging Face
- **Deployment**: Vercel

## Installation

To run the project locally, follow these steps:

1. **Clone the repository**:
   ```bash
   git clone https://github.com/YGNTECHSTARTUP/imaginify.git
   cd imaginify
  1. Install dependencies:

    npm install
  2. Set up environment variables: Create a .env.local file in the root directory and add the necessary environment variables (see Environment Variables).

  3. Run the development server:

    npm run dev

    Open http://localhost:3000 to view it in the browser.

Usage

  1. Sign up / Log in:

    • Use the Clerk-powered authentication to sign up or log in.
  2. Generate Images:

    • Enter a prompt in the chat interface to generate an image using the Hugging Face model.

Environment Variables

The following environment variables need to be set up in your .env.local file:

NEXT_PUBLIC_CLERK_FRONTEND_API=<your-clerk-frontend-api>
CLERK_API_KEY=<your-clerk-api-key>
NEXT_PUBLIC_HUGGING_FACE_API_KEY=<your-hugging-face-api-key>

Contributing

Contributions are welcome! Follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature-name).
  6. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Contact