Lisa_Stuff/pvtchat
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
pvtchat/README.md

3.0 KiB
Raw Blame History

PVTChat - Messaging Made Simple.

PVTChat is an app, similar to Discord, but cooler. Built with React, TypeScript, and Node.js (18). Main point of PVT Chat is to fix accord bugs and continue maintenance for said app.

PVTChat is based on acrd.app, leave a star to original creator!

Text Channel Custom Themes Showcase Screenshot-from-2021-08-31-16-09-41 Profile Showcase Screenshot-from-2021-08-30-13-30-43 Screenshot-from-2021-08-30-11-55-01

Setup

  1. Clone the repo (from Gitea).
  2. Generate JWT key (secure user logins). From app directory: 
    mkdir -p backend/keys
ssh-keygen -t rsa -b 2048 -m PEM -f backend/keys/jwt
  3. Install npm packages. From app directory: 
    # Install global dependencies
npm i -g typescript

# Install local packages
cd frontend && npm i -f
cd ../backend && npm i -f
  4. Add upload folder.
mkdir -p assets/upload
  1. In backend directory, configure .env.example and rename the file to .env
  2. In frontend/env directory, configure .env.dev and .env.prod file.
  3. To run application in dev or production mode move back to project root directory and type:
# for development
docker-compose -f docker-compose.dev.yml up
# for production
docker-compose -f docker-compose.prod.yml up 
# use -d tag to run it in the background
# use --build tag to build app

Features

  • Server Channels
    • Create channels
    • Delete channels
  • Message Management
    • Server owners can delete any message
    • Message author can delete and edit their own messages
  • Member Management
    • Kick members as the server owner
    • Easily leave the server by right clicking the server
    • Join servers with an invite code
  • Server Management
    • Create servers as you would in Discord
    • Edit server name, and icon URL in the server settings
    • Delete your server in the server settings
  • User Management
    • Manage your account by clicking the settings icon
    • Change your username, and avatar
    • Delete your user and prevent it from being used to login
  • and more (of course)

Troubleshooting

App does not connect to MongoDB in Docker?

  • Ensure MongoDB is installed.
  • If localhost does not work, use mongodb://database/accord.