diff --git a/README.md b/README.md new file mode 100644 index 000000000..57f7a77bd --- /dev/null +++ b/README.md @@ -0,0 +1,130 @@ + + +
+ + + +

Lobe Chat

+ +Lobe Chat is an open-source chatgpt client + +[Changelog](./CHANGELOG.md) · [Report Bug][issues-url] · [Request Feature][issues-url] + + + +[![release][release-shield]][release-url] +[![releaseDate][release-date-shield]][release-date-url] +[![ciTest][ci-test-shield]][ci-test-url] +[![ciRelease][ci-release-shield]][ci-release-url] +
+[![contributors][contributors-shield]][contributors-url] +[![forks][forks-shield]][forks-url] +[![stargazers][stargazers-shield]][stargazers-url] +[![issues][issues-shield]][issues-url] + +![](https://github.com/othneildrew/Best-README-Template/raw/master/images/screenshot.png) + +
+ +## ⌨️ Local Development + +You can use Gitpod for online development: + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][gitpod-url] + +Or clone it for local development: + +```bash +$ git clone https://github.com/lobehub/lobe-chat.git +$ cd canisminor-template +$ npm install +$ npm start +``` + +
+ +[![][back-to-top]](#readme-top) + +
+ + +## 🤝 Contributing + + + +> 📊 Total: **3** + + + + + + + + + + + + + +
+ +[![][back-to-top]](#readme-top) + +
+ +--- +#### 📝 License + +Copyright © 2023 [LobeHub][profile-url].
+This project is [MIT](./LICENSE) licensed. + + + + +[profile-url]: https://github.com/lobehub +[issues-url]: https://github.com/lobehub/lobe-chat/issues/new/choose +[gitpod-url]: https://gitpod.io/#https://github.com/lobehub/lobe-chat + + + +[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square + + + +[release-shield]: https://img.shields.io/github/v/release/lobehub/lobe-chat?style=flat&sort=semver&logo=github +[release-url]: https://github.com/lobehub/lobe-chat/releases + + + +[release-date-shield]: https://img.shields.io/github/release-date/lobehub/lobe-chat?style=flat +[release-date-url]: https://github.com/lobehub/lobe-chat/releases + + + +[ci-test-shield]: https://github.com/lobehub/lobe-chat/workflows/Test%20CI/badge.svg +[ci-test-url]: https://github.com/lobehub/lobe-chat/actions/workflows/test.yml + + + +[ci-release-shield]: https://github.com/lobehub/lobe-chat/workflows/Build%20and%20Release/badge.svg +[ci-release-url]: https://github.com/lobehub/lobe-chat/actions/workflows/release.yml + + + +[contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-chat.svg?style=flat +[contributors-url]: https://github.com/lobehub/lobe-chat/graphs/contributors + + + +[forks-shield]: https://img.shields.io/github/forks/lobehub/lobe-chat.svg?style=flat +[forks-url]: https://github.com/lobehub/lobe-chat/network/members + + + +[stargazers-shield]: https://img.shields.io/github/stars/lobehub/lobe-chat.svg?style=flat +[stargazers-url]: https://github.com/lobehub/lobe-chat/stargazers + + + +[issues-shield]: https://img.shields.io/github/issues/lobehub/lobe-chat.svg?style=flat +[issues-url]: https://img.shields.io/github/issues/lobehub/lobe-chat.svg?style=flat