https://github.com/markprompt/markprompt-js
JavaScript SDK for Markprompt
https://github.com/markprompt/markprompt-js
gpt-4 open-source react typescript vanilla
Last synced: 6 months ago
JSON representation
JavaScript SDK for Markprompt
- Host: GitHub
- URL: https://github.com/markprompt/markprompt-js
- Owner: markprompt
- License: mit
- Created: 2023-04-16T18:58:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-18T00:54:56.000Z (7 months ago)
- Last Synced: 2025-03-28T18:56:13.387Z (6 months ago)
- Topics: gpt-4, open-source, react, typescript, vanilla
- Language: TypeScript
- Homepage: https://markprompt.com
- Size: 10.7 MB
- Stars: 56
- Watchers: 2
- Forks: 10
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Markprompt is AI for customer support.
## Components
This repo contains various UI libraries for building prompts based on the
Markprompt API:
- [`@markprompt/core`](packages/core#readme) — shared utility functions to speak
with the Markprompt API.
- [`@markprompt/react`](packages/react#readme) — a React component.
- [`@markprompt/web`](packages/web#readme) — a pre-built Markprompt component,
based on `@markprompt/react`, built with Preact for bundle-size savings.
Viable for use with vanilla JavaScript or any framework.
- [`@markprompt/docusaurus-theme-search`](packages/docusaurus-theme-search#readme)
— a Markprompt search theme for Docusaurus.
and some example implementations:
- [`with-css-modules`](examples/with-css-modules#readme) — a web application based on `@markprompt/react`, Vite and CSS Modules.
- [`with-custom-trigger`](examples/with-custom-trigger#readme) — a reference implementation of `@markprompt/web` using a custom trigger button.
- [`with-custom-trigger-react`](examples/with-custom-trigger-react#readme) — a reference implementation of `@markprompt/react` using a custom trigger button.
- [`with-docusaurus`](examples/with-docusaurus#readme) — a Docusaurus project with `@markprompt/docusaurus-theme-search`.
- [`with-docusaurus-algolia`](examples/with-docusaurus-algolia#readme) — a Docusaurus project with `@markprompt/docusaurus-theme-search` and our Algolia
integration.
- [`with-docusaurus-swizzled`](examples/with-docusaurus-swizzled#readme) — a Docusaurus project with Markprompt and [theme-search-algolia](https://docusaurus.io/docs/api/themes/@docusaurus/theme-search-algolia).
- [`with-init`](examples/with-init#readme) — a web application based on
`@markprompt/web` using a global instance of Markprompt.
- [`with-markprompt-web`](examples/with-markprompt-web#readme) — a web application based on `@markprompt/web` and Vite. based on `@markprompt/react`, Vite and CSS Modules.
- [`with-next`](examples/with-next#readme) — a web application based on `@markprompt/react`, `@markprompt/web`, and Next.js.
- [`with-function-calling`](examples/with-function-calling#readme) — a web application based on `@markprompt/react` and Next.js showcasing the use for [OpenAI function calling](https://platform.openai.com/docs/guides/function-calling).
- [`with-automatic-ticket-creation`](examples/with-automatic-ticket-creation#readme) — a web application based on `@markprompt/web` and Vite showcasing automatic ticket creation.
## Running examples
To run examples from this monorepo:
```sh
pnpm turbo dev --filter with-markprompt-web...
```
## Documentation
To use the Markprompt platform as is, please refer to the
[Markprompt documentation](https://markprompt.com/docs).
## Community
- [X](https://x.com/markprompt)
## Authors
This library is created by the team behind [Markprompt](https://markprompt.com)
([@markprompt](https://x.com/markprompt)).
## License
[MIT](./LICENSE) © [Markprompt](https://markprompt.com)