Code Monkey home page Code Monkey logo

chat's Introduction

openim-chat

๐Ÿ“„ License Options for OpenIM Source Code

You may use the OpenIM source code to create compiled versions not originally produced by OpenIM under one of the following two licensing options:

1. GNU General Public License v3.0 (GPLv3) ๐Ÿ†“

  • This option is governed by the Free Software Foundation's GPL v3.0.
  • Usage is subject to certain exceptions as outlined in this policy.

2. Commercial License ๐Ÿ’ผ

  • Obtain a commercial license by contacting OpenIM.
  • For more details and licensing inquiries, please email ๐Ÿ“ง [email protected].

๐Ÿงฉ Feature Overview

  1. This repository implements a business system, which consists of two parts: User System and Backend Management System.
  2. The system relies on the open-im-server repository and implements various business functions by calling the APIs of the instant messaging system.
  3. The User System includes regular functions such as user login, user registration, user information update, etc.
  4. The Backend Management System includes APIs for managing users, groups, and messages.

๐Ÿ‘ฅ Community

๐Ÿ›ซ Quick Start

โš ๏ธ Note: This project works on Linux/Windows/Mac platforms and both ARM and AMD architectures.

๐Ÿ“ฆ Clone

git clone https://github.com/openimsdk/chat openim-chat
cd openim-chat

๐Ÿ›  Initialization

๐Ÿ’ป Before the first compilation, execute on Linux/Mac platforms:

sh bootstrap.sh

๐Ÿ’ป On Windows execute:

bootstrap.bat

๐Ÿ— Build

mage

๐Ÿš€ Start

mage start

๐Ÿ’พ Or start in the background and collect logs

nohup mage start >> _output/logs/chat.log 2>&1 &

๐Ÿ”Ž Check

mage check

๐Ÿ›‘ Stop

mage stop

๐Ÿš€ Start Sequence

  1. Successfully start open-im-server.
  2. Compile chat mage.
  3. Start chat mage start.

๐Ÿ“ž If you want to enable audio and video calls, please configure LiveKit

๐Ÿ”— Please refer to "How to set up LiveKit server".

๐Ÿค Contributing

โค๏ธ Contributions to this project are welcome! Please see CONTRIBUTING.md for details.

๐Ÿšจ License

๐Ÿ“œ chat is licensed under the GPL-3.0 license. See the LICENSE for the full license text.

chat's People

Contributors

withchao avatar cubxxw avatar skiffer-git avatar luhaoling avatar hanzhixiao avatar andrewzuo01 avatar dependabot[bot] avatar mo3et avatar fgadvancer avatar bloomingg avatar wxuanf avatar cncsmonster avatar dangiant avatar polarisht avatar ouyangdage avatar chenqinghe avatar icey-yu avatar longyuqing112 avatar mrwenhui avatar wangchuxiao-dev avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.