https://github.com/poloclub/wordflow

Social and customizable AI writing assistant! ✍️
https://github.com/poloclub/wordflow

ai gemini gemini-pro gpt gpt-4 llama2 llm localllama mlc prompt-engineering writing-assistant

Last synced: 11 days ago
JSON representation

Social and customizable AI writing assistant! ✍️

• Host: GitHub
• URL: https://github.com/poloclub/wordflow
• Owner: poloclub
• License: mit
• Created: 2023-10-24T20:21:27.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-29T00:31:51.000Z (4 months ago)
• Last Synced: 2024-10-18T22:37:34.429Z (21 days ago)
• Topics: ai, gemini, gemini-pro, gpt, gpt-4, llama2, llm, localllama, mlc, prompt-engineering, writing-assistant
• Language: TypeScript
• Homepage: https://poloclub.github.io/wordflow/
• Size: 16.7 MB
• Stars: 182
• Watchers: 7
• Forks: 24
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-local-ai - Wordflow - Run, share, and discover AI prompts in your browsers (Inference UI)

README

        
Wordflow 


  

  





[![Github Actions Status](https://github.com/poloclub/wordflow/workflows/build/badge.svg)](https://github.com/poloclub/wordflow/actions/workflows/build.yml)

[![license](https://img.shields.io/badge/License-MIT-blue)](https://github.com/poloclub/wordflow/blob/main/LICENSE)

[![npm](https://img.shields.io/npm/v/wordflow?color=yellow)](https://www.npmjs.com/package/wordflow)

[![arxiv badge](https://img.shields.io/badge/arXiv-2401.14447-red)](https://arxiv.org/abs/2401.14447)

Social and customizable AI writing assistant tool ✍️

  

    

  

  

  

    🚀 Wordflow Demo

    📺 Demo Video

    

    📖 Research Paper

  

## What is Wordflow?

Wordflow is a social and customizable AI writing assistant tool! With Wordflow, you can easily write and run AI prompts with different large language models, including both external models (e.g., GPT 4 and Gemini Pro) and local models (e.g., Llama 2 and Phi 2). You can also discover and share your favorite prompts with the community.

  

    ✅

    Store and run your favorite AI prompts

  

  

  

    ✅

    Support different external LLMs (e.g., GPT 4 and Gemini Pro)

  

  

  

    ✅

    Support multiple on-device LLMs (e.g., Llama 2 and Phi 2)

  

  

  

    ✅

    Powerful customization (e.g., temperature, templates)

  

  

    

    ✅

    Discover and share community prompts

  

  

  

## Features



### Demo Video

  Click to see the demo video!

  

## Get Started

### Standalone Version

To use Wordflow, visit: .

If you use macOS, we highly recommend you [creating a Web App using Safari](https://support.apple.com/en-us/104996). Open [Wordflow](https://poloclub.github.io/wordflow/) in Safari, and then from the menu bar, choose `File` > `Add to Dock`.

Note that currently [Safari doesn't support WebGPU](https://caniuse.com/webgpu). If you want to use local LLMs, you can use Chrome to save Wordflow as a [Chrome app](https://support.google.com/chrome_webstore/answer/3060053?hl=en). In Chrome, at the top right, click `More` > `More Tools` > `Create shortcut`.



### Google Doc Add-on

If you use Google Doc, we also provide a Wordflow Add-on that you can install from the [Google Workspace Marketplace](https://workspace.google.com/marketplace/app/wordflow/851135867974). The source code of the add-on is in [this repository](https://github.com/poloclub/wordflow-doc).

## Developing Wordflow

Clone or download this repository:

```bash

git clone [email protected]:poloclub/wordflow.git

```

Install the dependencies:

```bash

npm install

```

Then run Wordflow:

```

npm run dev

```

Navigate to localhost:3000. You should see Wordflow running in your browser :)

## Credits

Wordflow is created by Jay Wang, Aishwarya Chakravarthy, David Munechika, and Polo Chau.

## Citation

To learn more about Wordflow and social prompt engineering, check out our [research paper](https://arxiv.org/abs/2401.14447).

```bibtex

@article{wangWordflowSocialPrompt2024,

  title = {Wordflow: {{Social Prompt Engineering}} for {{Large Language Models}}},

  shorttitle = {Wordflow},

  author = {Wang, Zijie J. and Chakravarthy, Aishwarya and Munechika, David and Chau, Duen Horng},

  year = {2024},

  url = {http://arxiv.org/abs/2401.14447},

  urldate = {2024-01-29},

  archiveprefix = {arxiv},

  journal = {arXiv 2401.14447}

}

```

## License

The software is available under the [MIT License](https://github.com/poloclub/wordflow/blob/main/LICENSE).

## Contact

If you have any questions, feel free to [open an issue](https://github.com/poloclub/wordflow/issues/new) or contact [Jay Wang](https://zijie.wang).