npm package: @lobehub/lobe-chat-plugins
Description: <a name="readme-top"></a>
Author: LobeHub
Latest version: 1.7.0

<a name="readme-top"></a>

<div align="center">

<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji/1.3.0/files/assets/puzzle-piece.webp">
<img height="120" src="https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg">
<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji/1.3.0/files/assets/convenience-store.webp">

<h1>LobeChat Plugins Index</h1>

[Lobe Chat](https://github.com/lobehub/lobe-chat) accesses [`index.json`](https://registry.npmmirror.com/@lobehub/lobe-chat-plugins/latest/files) from this repo to show user the list of available plugins.

</div>


<details>
<summary><kbd>Table of contents</kbd></summary>

#### TOC

- [🚀 How to submit plugin](#-how-to-submit-plugin)
- [👀 Notes](#-notes)
- [🛳 Self Hosting](#-self-hosting)
- [🤝 Contributing](#-contributing)

####

</details>

## 🚀 How to Submit your Plugin

If you wish to add a plugin onto the index, make an entry in `plugins` directory using `plugin_template.json`, write a short description and tag it appropriately then open as a pull request ty!

### Step-by-step Instructions

1. Fork of this repository.

2. Make a copy of `plugin_template.json`

3. Fill in the copy and rename it appropriately

4. Move it into `plugins` directory

5. Submit a pull request and wait for review.

- The `createAt` date will be automatically populated after merge.

## 👀 Notes

- An plugin will need to be functioning for it to be included.

- If plugin is no longer functional and or not maintained, we might redirect it to a fork or remove it form the index.

- Not all plugins will be accepted, we will review the plugin and make an assessment.

- You can submit plugins even if you are not the author, but it is preferred that the author do it themselves.

- If you wish to have your plugin removed, or believes the description does not properly describe your plugin, please open the issue or pull request.

## 🛳 Self Hosting

If you want to deploy this service by yourself, you can follow the steps below.

### Deploy to Vercel

Click button below to deploy your private plugins index.

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flobehub%2Flobe-chat-plugins&project-name=lobe-chat-plugins&repository-name=lobe-chat-plugins)

## 🤝 Contributing

<!-- CONTRIBUTION GROUP -->

> 📊 Total: <kbd>**2**</kbd>

<a href="https://github.com/arvinxx" title="arvinxx">
  <img src="https://avatars.githubusercontent.com/u/28616219?v=4" width="50" />
</a>
<a href="https://github.com/actions-user" title="actions-user">
  <img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
</a>

<!-- CONTRIBUTION END -->

<div align="right">

[![][back-to-top]](#readme-top)

</div>

---

#### 📝 License

Copyright © 2023 [LobeHub][profile-url]. <br />
This project is [MIT](./LICENSE) licensed.

<!-- PLUGIN GROUP -->

[plugin-shield]: https://img.shields.io/badge/%F0%9F%A4%AF_LobeChat-plugin-cyan
[plugin-url]: https://github.com/lobehub/lobe-chat-plugins

<!-- LINK GROUP -->

[profile-url]: https://github.com/lobehub
[gitpod-url]: https://gitpod.io/#https://github.com/lobehub/chat-plugins-gateway

<!-- SHIELD LINK GROUP -->

[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square

<!-- release -->

[release-shield]: https://img.shields.io/npm/v/@lobehub/chat-plugins-gateway?label=%F0%9F%A4%AF%20NPM
[release-url]: https://www.npmjs.com/package/@lobehub/chat-plugins-gateway

<!-- releaseDate -->

[release-date-shield]: https://img.shields.io/github/release-date/lobehub/chat-plugins-gateway?style=flat
[release-date-url]: https://github.com/lobehub/chat-plugins-gateway/releases

<!-- ciTest -->

[ci-test-shield]: https://github.com/lobehub/chat-plugins-gateway/actions/workflows/test.yml/badge.svg
[ci-test-url]: https://github.com/lobehub/chat-plugins-gateway/actions/workflows/test.yml

<!-- ciRelease -->

[ci-release-shield]: https://github.com/lobehub/chat-plugins-gateway/actions/workflows/release.yml/badge.svg
[ci-release-url]: https://github.com/lobehub/chat-plugins-gateway/actions/workflows/release.yml

<!-- contributors -->

[contributors-shield]: https://img.shields.io/github/contributors/lobehub/chat-plugins-gateway.svg?style=flat
[contributors-url]: https://github.com/lobehub/chat-plugins-gateway/graphs/contributors

<!-- forks -->

[forks-shield]: https://img.shields.io/github/forks/lobehub/chat-plugins-gateway.svg?style=flat
[forks-url]: https://github.com/lobehub/chat-plugins-gateway/network/members

<!-- stargazers -->

[stargazers-shield]: https://img.shields.io/github/stars/lobehub/chat-plugins-gateway.svg?style=flat
[stargazers-url]: https://github.com/lobehub/chat-plugins-gateway/stargazers

<!-- issues -->

[issues-shield]: https://img.shields.io/github/issues/lobehub/chat-plugins-gateway.svg?style=flat
[issues-url]: https://github.com/lobehub/chat-plugins-gateway/issues/new/choose