Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gcascio/promptato
Sometimes you just want to map some user input to a prompt and present the result be it to share some magic with your friends and family or simply because you feel like a prompt potato.
https://github.com/gcascio/promptato
chatgpt tools ui
Last synced: about 4 hours ago
JSON representation
Sometimes you just want to map some user input to a prompt and present the result be it to share some magic with your friends and family or simply because you feel like a prompt potato.
- Host: GitHub
- URL: https://github.com/gcascio/promptato
- Owner: gcascio
- Created: 2023-05-28T18:36:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-03T18:39:33.000Z (7 months ago)
- Last Synced: 2024-05-29T22:47:01.400Z (5 months ago)
- Topics: chatgpt, tools, ui
- Language: TypeScript
- Homepage:
- Size: 24 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Intro
Sometimes you just want to map some user input to a prompt and present the result be it to share some magic with your friends and family or simply because you feel like a prompt potato.
https://github.com/gcascio/promptato/assets/35739042/896020e8-0cad-4b4f-a76b-eaa9f9993c77
### Technologies used
- [Next.js](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [OpenAI API](https://platform.openai.com/docs/introduction)
## :clapper: Examples
Have a look at the examples in `/app/examples` to get some inspiration about what is possible:
## :technologist: Usage
There is no package yet so this repo acts as template. Simply fork or clone it to get started.
```sh
# ssh
git clone [email protected]:gcascio/promptato.git
# https
git clone https://github.com/gcascio/promptato.git
```
To start the application run
```
pnpm install
```
create a `env.local` file (see `env.example`) and run
```
pnpm dev
```
### Customizing
Using the higher order function `createPromptato` you can easily define a input-prompt mapping:
```typescript
// promptato.ts
import { createPromptato } from "@/lib/createPromptato";
export const Promptato = createPromptato({
myInput: {
component: 'input',
label: 'What is your name?',
},
}, [
{
role: 'system',
content:
`You are a comedian making fun of the tch scene.
You will write a funny story about a topic you will receive.
You must limit the story to 100 words.
Format your response using markdown.`
},
{
role: 'user',
content: (inp) =>
`${inp.myInput} feels lazy about writing prompts for LLM's.`
}
])
```
The returned component `Promptato` can then be used in a page:
```tsx
// page.ts
import { Promptato } from './promptato';
const Page = () => (
Feeling like a Prompt Potato?
);
export default Page;
```
## :monocle_face: API
The API of promptato is straightforward and self explanatory with the hep of the typings.
As shown in the example above `createPromptato` expects two arguments, the input definition and the prompt definition. All input values can be accessed in the prompt definition.
Each input of the input definition has the following properties:
| Property | Required | Description |
| ---------------------------------------------- | ----------------------------------- | ------------------------------------ |
| `component: 'input' \| 'select' \| 'textarea'` | Yes | The component type |
| `label: string` | Yes | Label describing the input |
| `initialValue: string \| number` | No | Initial value of the input component |
| `type: string \| number` | No (only for `'input'` component) | Options of select element |
| `options: string[]` | Yes (only for `'select'` component) | Options of select element |
A message in the prompt definition has following properties:
| Property | Required | Description |
| ----------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
| `role: 'assistant' \| 'system' \| 'user'` | Yes | The [role](https://platform.openai.com/docs/api-reference/chat/create#chat/create-role) of the author of this message |
| `content: string \| (inputs) => string` | Yes | The contents of the message. |
| `name: string` | No | The name of the author of this message |
## :hammer_and_wrench: Contributing
Interested in contributing? Great!
To fix a bug or add a feature, follow these steps:
- Create a [Fork](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#forking-a-repository) of the repo
- Create a new branch (`git checkout -b your-branch`)
- Add your changes
- Commit your changes (`git commit -am 'feat: fantastic feature'`)
- Push the branch (`git push origin your-branch`)
- Create a [Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#forking-a-repository)
## :raising_hand: FAQ
### Why Promptato?
It is a reference to the famous "Couch Potato" cliche.