https://github.com/duskmoon314/dewhale

https://github.com/duskmoon314/dewhale

Last synced: 27 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/duskmoon314/dewhale
• Owner: duskmoon314
• License: apache-2.0
• Created: 2024-08-28T07:55:14.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-10-14T20:18:42.000Z (3 months ago)
• Last Synced: 2024-10-27T16:08:34.642Z (3 months ago)
• Language: JavaScript
• Size: 1.91 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



# Dewhale

Dewhale is a GitHub-Powered AI for effortless development.

[中文文档](./README.zh_CN.md)

> If you are looking for vx.dev, check our [rebranding discussion](https://github.com/Yuyz0112/dewhale/discussions/189).

## Quick Start

For detailed instructions on how to set up and use Dewhale, please refer to our [Guide](./docs/quick-start.md).

> With the power of our quota management feature, we allow stargazers to have 3 trials.

You can also watch this [demo video](http://www.youtube.com/watch?v=J4LAOBRcu2c).

More examples can be found in the [issue list](https://github.com/Yuyz0112/dewhale/issues?q=is%3Aissue+label%3Aui-gen%2Cvue-ui-gen).

## Features

### Lower Usage Costs

Dewhale utilizes prompt engineering techniques under the GPT-4 model to issue commands. The main cost involves the number of input and completion tokens. Our current prompt, found in [prompts/ui-gen.md](./prompts/ui-gen.md), includes instructions for [shadcn/ui](https://ui.shadcn.com/), [lucide](https://lucide.dev/), and [nivo charts](https://nivo.rocks/).

If you do not need certain components (e.g., charts), you can reduce the API cost per generation by removing instructions from the prompt.

And you can also switch to other AI models for lower usage costs.

### Easy Customization

Since Dewhale's prompt is open-sourced, you can refer to the existing prompt and replace it with other UI component libraries or coding styles as per your requirements.

You can also customize the whole workflow by yourself, e.g., a v0.dev-like Web App, and just use Dewhale's prompt as a core.

### Seamless GitHub Integration

The generated code is stored on GitHub, inherently equipped with version control, code review, and collaborative features.

Additionally, you can use a private repo to keep your code generation results visible only to collaborators.

## How It Works

To understand the underlying architecture and workings of Dewhale, please see our detailed [Architecture Overview](./docs/architecture.md).

## Join the Discussions

If you like the design philosophy of Dewhale, feel free to join our [Github Discussions](https://github.com/Yuyz0112/dewhale/discussions).