English | 中文(普通话-大陆)

Table of Contents

• Table of Contents
• Introduction
• Installation
  • Server
  • Client
• Running
• Features Implemented
• To-Do List
• Document
• Maintainers
• License
• Disclaimer

Introduction

re_hcat-server is a reset version server of HCat, developed with Python. This project is licensed under the AGPLv3 license.

We welcome more developers to join our project and build a more perfect HCat server together!

Installation

Server

Currently, the server is not available in any release version(It may not be available in the future). Please use Git to get the server:

git clone https://github.com/HCAT-Project/re_hcat-server.git
pip install -r requirements.txt

Client

If you have downloaded and configured git correctly, the client will be automatically cloned from the GitHub repository when the server starts. And it will be available at http://localhost:8080/.

Of course, you can disable or change the client version by modifying the /client/client-branch setting in the configuration file.

The following table shows the version number and corresponding branch of the client:

Branch	Value	Comment
Main (stable)	"main"	Stable? Maybe...
Development	"dev"
Disable client	null

Running

Please run with Python 3.10 and above!

python start.py

In addition, I strongly recommend using a server such as nginx to reverse proxy api and distribute static resources!

Also, use port 443(https,wss) or 80(http,ws) for external open ports if possible.

Features Implemented

• Account Management: Register, login, change password, change user nickname, get user information, email binding, etc.
• Friend Management: Add friends, delete friends, set friend nicknames, get friend lists, get friend information, etc.
• Group Management: Create groups, join groups, leave groups, change group names, change group settings, transfer group ownership, get group lists, etc.
• Chatting Function: Private chat, group chat, sending text, images, upload file etc.

To-Do List

• Add user personalization settings.
• Server master-slave.
• Multi-device collaboration.
• Backend management.
• Delete groups/cancel accounts.
• Add multiple ways to add friends.

Document

Document	Remarks
Project Structure
Development Guide
Translation Guide	English only

Maintainers

@hsn8086

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
We hope this program will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Disclaimer

This project is for learning and communication only. Users should comply with the relevant laws and regulations of their country or region. This project is not responsible for any consequences of illegal use.