Metadata-Version: 2.1
Name: gen-ui-kit
Version: 0.1.1
Summary: Gen-UI-Kit is a developer tool that generates starter web UI kits based on project ideas and descriptions. Leveraging LangChain and Cloudscape Design System, it simplifies the process of starting a project by providing a customizable UI kit. Developers can easily connect the generated kit to their APIs or backends, accelerating the early stages of development for new apps or front-end interfaces.
Home-page: https://github.com/makkzone/Gen-UI-Kit
Author: Manojkumar Kotakonda
Author-email: manojkumar.kotakonda@gmail.com
License: MIT License
        
        Copyright (c) 2024 Manojkumar Kotakonda
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: langchain==0.3.2
Requires-Dist: gitpython==3.1.43

# Gen-UI-Kit

**Gen-UI-Kit** is a powerful tool designed to generate starter web UI kits based on a simple input: a project idea and its description and by utilizing [**LangChain**](https://github.com/langchain-ai/langchain) and UI Design systems such as [**Cloudscape Design System**](https://cloudscape.design/). It helps developers quickly get started on their projects with a tailored UI kit, ready for customization and enhancement. Developers can use this starter kit to connect to their APIs or backends, speeding up the initial phase of development.

Whether you’re working on a new app idea or looking for a quick way to start a front-end interface, Gen-UI-Kit is here to help!

## Key Features

- **Idea-Based UI Generation**: Provide a project idea and its description, and Gen-UI-Kit generates a customized starter UI kit.
- **Cloudscape Design System**: Utilizes components from Cloudscape to ensure a clean, consistent, and modern UI.
- **Customizable Starter Kit**: Get a functional starting point for your web app, which you can easily customize and extend.
- **Backend/ API Ready**: Generated starter kits include placeholders and structured code for easy API and backend integration.
- **Boosts Productivity**: Skip the tedious setup phase and jump straight into building your project with the generated kit.

## How It Works

1. **Input Your Idea**: Describe the project idea and provide a brief description of what it should do. For example: "create starter kit for the idea insurance underwriting app."
2. **Generate Starter Kit**: Gen-UI-Kit uses your input to generate a tailored web UI kit, complete with components and layouts that match your description.

## Example

Checkout the examples [notebooks](https://github.com/makkzone/Gen-UI-Kit/tree/main/notebooks)


## Installation

1. Using pip:

   ```bash
   pip install gen_ui_kit
   ```

(or)

2. Clone the repo and build locally:

   ```bash
   git clone https://github.com/makkzone/Gen-UI-Kit.git

   cd Gen-UI-Kit

   pip install -e .
   ```
