You may be licensed to use source code to create compiled versions not produced by OpenIM in one of two ways:
- Under the Free Software Foundationβs GPL v.3.0, subject to the exceptions outlined in this policy; or
- Under a commercial license available from OpenIM by contacting contact@openim.io
chat
Modifying configuration items
Refer to config/config.yaml
for configuration instructions
𧩠Awesome features
- This repository implement a business system, which consists of two parts: User related function and background management function
- The business system depends on the api of the im system (Open-IM-Server repository) and implement various functions by calling the api of the im system
- User related part includes some regular functions like user login, user register, user info update, etc.
- Background management provides api for admin to manage the im system containing functions like user management, message mangement,group management,etc.
π« Quick start
Note: You can get started quickly with OpenIM Chat.
π¦ Installation
git clone https://github.com/OpenIMSDK/chat openim-chat && export openim-chat=$(pwd)/openim-chat && cd $openim-chat && make
Developing chat
If you wish to deploy chat, then you should first install and deploy OpenIM, this Open-IM-Server repository
git clone -b release-v3.1 https://github.com/OpenIMSDK/Open-IM-Server.git openim && export openim=$(pwd)/openim && cd $openim
sudo docker compose up -d
Installing Chat
$ make install
π« Quick start
Note: You can get started quickly with chat.
π Run
Note: We need to run the backend server first
$ make build
# OR build Specifying binary
$ make build BINS=admin-api
# OR build multiarch
$ make build-multiarch
$ make build-multiarch BINS="admin-api"
# OR use scripts build source code
$ ./scripts/build_all.sh
π Contributors get up to speed
Be good at using Makefile, it can ensure the quality of your project.
Usage: make <TARGETS> ...
Targets:
all Build all the necessary targets. ποΈ
build Build binaries by default. π οΈ
go.build Build the binary file of the specified platform. π¨βπ»
build-multiarch Build binaries for multiple platforms. π
tidy tidy go.mod π¦
style Code style -> fmt,vet,lint π¨
fmt Run go fmt against code. β¨
vet Run go vet against code. π
generate Run go generate against code and docs. β
lint Run go lint against code. π
test Run unit test βοΈ
cover Run unit test with coverage. π§ͺ
docker-build Build docker image with the manager. π³
docker-push Push docker image with the manager. π
docker-buildx-push Push docker image with the manager using buildx. π’
copyright-verify Validate boilerplate headers for assign files. π
copyright-add Add the boilerplate headers for all files. π
swagger Generate swagger document. π
serve-swagger Serve swagger spec and docs. π
clean Clean all builds. π§Ή
help Show this help info. βΉοΈ
Note: It's highly recommended that you run
make all
before committing your code. π
$ make all
Chat Start
$ make start_all
# OR use scripts start
$ ./scripts/start_all.sh
Chat Detection
$ make check
# OR use scripts check
$ ./scripts/check_all.sh --print-screen
Chat Stop
$ make stop
# OR use scripts stop
$ ./scripts/stop_all.sh
Contributing
Contributions to this project are welcome! Please see CONTRIBUTING.md for details.
Community Meetings
We want anyone to get involved in our community, we offer gifts and rewards, and we welcome you to join us every Thursday night.
We take notes of each biweekly meeting in GitHub discussions, and our minutes are written in Google Docs.
Who are using Open-IM-Server
The user case studies page includes the user list of the project. You can leave a πcomment to let us know your use case.
π¨ License
chat is licensed under the Apache 2.0 license. See LICENSE for the full license text.