mirror of
https://github.com/lobehub/lobehub.git
synced 2026-03-26 13:19:34 +07:00
📝 docs: Create README.md
This commit is contained in:
130
README.md
Normal file
130
README.md
Normal file
@@ -0,0 +1,130 @@
|
||||
<a name="readme-top"></a>
|
||||
|
||||
<div align="center">
|
||||
|
||||
<img width="160" src="https://raw.githubusercontent.com/lobehub/.github/main/profile/Logo.webp">
|
||||
|
||||
<h1>Lobe Chat</h1>
|
||||
|
||||
Lobe Chat is an open-source chatgpt client
|
||||
|
||||
[Changelog](./CHANGELOG.md) · [Report Bug][issues-url] · [Request Feature][issues-url]
|
||||
|
||||
<!-- SHIELD GROUP -->
|
||||
|
||||
[![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]
|
||||
<br/>
|
||||
[![contributors][contributors-shield]][contributors-url]
|
||||
[![forks][forks-shield]][forks-url]
|
||||
[![stargazers][stargazers-shield]][stargazers-url]
|
||||
[![issues][issues-shield]][issues-url]
|
||||
|
||||

|
||||
|
||||
</div>
|
||||
|
||||
## ⌨️ Local Development
|
||||
|
||||
You can use Gitpod for online development:
|
||||
|
||||
[][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
|
||||
```
|
||||
|
||||
<div align="right">
|
||||
|
||||
[![][back-to-top]](#readme-top)
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
<!-- CONTRIBUTION GROUP -->
|
||||
|
||||
> 📊 Total: <kbd>**3**</kbd>
|
||||
|
||||
<a href="https://github.com/canisminor1990" title="canisminor1990">
|
||||
<img src="https://avatars.githubusercontent.com/u/17870709?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>
|
||||
<a href="https://github.com/apps/dependabot" title="dependabot[bot]">
|
||||
<img src="https://avatars.githubusercontent.com/in/29110?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.
|
||||
|
||||
|
||||
<!-- LINK GROUP -->
|
||||
|
||||
[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
|
||||
|
||||
<!-- 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/github/v/release/lobehub/lobe-chat?style=flat&sort=semver&logo=github
|
||||
[release-url]: https://github.com/lobehub/lobe-chat/releases
|
||||
|
||||
<!-- releaseDate -->
|
||||
|
||||
[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
|
||||
|
||||
<!-- ciTest -->
|
||||
|
||||
[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
|
||||
|
||||
<!-- ciRelease -->
|
||||
|
||||
[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 -->
|
||||
|
||||
[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 -->
|
||||
|
||||
[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 -->
|
||||
|
||||
[stargazers-shield]: https://img.shields.io/github/stars/lobehub/lobe-chat.svg?style=flat
|
||||
[stargazers-url]: https://github.com/lobehub/lobe-chat/stargazers
|
||||
|
||||
<!-- issues -->
|
||||
|
||||
[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
|
||||
Reference in New Issue
Block a user