Skip to content

konradjoz/ChatX

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation


ChatX - Simply Powerful

GitHub followers badge GitHub followers badge GitHub followers badge

Features

  • Read and write user data to MongoDB
  • Websocket communication between backend and frontend
  • Custom routes and components
  • Bootstrap 5 Desktop and Mobile focused design

Screenshots

Home Example Screenshot About Example Screenshot Room Example Screenshot

Tech Stack

  • FastAPI - Asynchronous backend (ASGI)
  • MongoDB - NoSQL database for retrieval of documents
  • React - Javascript UI components for modern web apps
  • Bootstrap 5 - Mobile first styling for all components (simple & sleek)

Installation

git clone https://github.com/konradjoz/ChatX
cd frontend/
# Install npm Dependencies
npm install package.json
npm start

# Install pip Dependencies
cd ..
cd backend/
pip3 install -r requirements.txt
main.py -m uvicorn backend.main:app --reload

** Note: I recommend the compound configuration provided by many JetBrains products (WebStorm, PyCharm, etc.)

RoadMap

  • React

    • Create profile, room, and user routes
    • Fix websocket close errors
    • Add download routes for message history
  • FastApi

    • Add async POST routes for messages
    • Add async GET protected routes for sensitive user data
    • Update database package for reusability
  • Bootstrap

    • Add GSAP animations for logo, titles, and components