Skip to content

Latest commit

 

History

History
119 lines (101 loc) · 4.21 KB

README.md

File metadata and controls

119 lines (101 loc) · 4.21 KB

Open-source chat application similar to Discord-

💛 Official website: https://nekonetwork.net
✔️ Releases: https://github.com/LamkasDev/liquidchat/releases

📓 Documentation: https://nekonetwork.net/docs
🔥 API: https://github.com/LamkasDev/liquidchat.js
🔴 Found a bug or want to contribute?: [Open a pull request]

🏁 Features:

  • Servers with Text and Voice Channels
  • DM Channels
  • Group Chats
  • File Support (up to 100MB by default)
  • Personal Emotes (max. 500)
  • Server Emotes (max. 400)
  • Idle/DND/Invisible Status
  • Custom Statuses
  • Friend Features (Adding/Removing friends)
  • Searches, Pinned Messages, Connections, Notes
  • Server banners and animated avatars for free
  • Better Server Management (Built-in bans, mutes, assigning server moderators)
  • Server Discovery
  • Voice Channels
  • Android/IOS Support
  • Rich Presence
  • a lot more...

Build instructions:

a) How to build client (Windows)
run npm run createproduction-win
the installer will be built into /client/dist
c) How to test client (Windows)
run yarn start
d) How to host server yourself
1) Setup your folder structure to look like the following:

lc-full.sh
/lc
   /liquidchat
      /client
      /server
   /liquidchat-fileserver
      /public
      /keys
      simpleserver.js
   /liquidchat-web
      /public
      /keys
      server.js
  
 2) (Alternative, but recommended) Get a certificate and key for your server's domain, if you don't have one already
 3) (Alternative, but recommended) Put key.pem and cert.pem into each /keys directories
 4) You will need MySQL installed so do it if you don't have it already (for Ubuntu here)
 5) Import the MySQL template file from here to create the needed datebase structure (will add later™)
 6) Create a /data folder in liquidchat/server and a file named config_persistent.txt
 7) Edit this file to fit the format (will add later™)
 8) Run sudo lc-full.sh /home/YOUR_USERNAME/lc/
d) How to deploy web versions...
1) On your local machine, in the /client directory run npm run build
2) Zip all the files in the /client/build folder (not the folder) into a file named build.zip
3) Place this file into /lc folder on your server
4) Restart your server (that'll unpack the assets from build.zip and place them into /liquidchat-web/public)
or alternatively use Github Actions where web versions are built automatically
f) Additional setup
change APIEndpoint in /client/App.js to your server's domain:8080  
change fileEnpoint in /client/App.js to your server's domain:8081  
change filesStorage in /server/server.js to directory where you run your file server
g) Known issues
if using the insecure useHTTP flag, websocket sessions can't exchange browser cookies,
so server uses the first logged in session

Example Screenshots:

Client (2021/2/1) example1

Documentation (2021/2/1) example2