Skip to content

Latest commit

 

History

History
81 lines (67 loc) · 2.78 KB

README.md

File metadata and controls

81 lines (67 loc) · 2.78 KB

Neo Live Chat

A Reactive live chat application that connects random users for real-time communication. This project demonstrates the use of the WebSocket protocol to enable bidirectional communication between clients and the server. Built using React.js on the front end and FastAPI on the back end, this example illustrates how WebSockets can be implemented to handle real-time chat functionality, ensuring seamless communication between users.

Project preview

Links

Features

  • Real-time chat: uses web socket protocol to enable live communication between random users.
  • Scalable architecture: built with FastAPI and React.js, it ensures high-performance communication.
  • React.jsive UI: front end built with React.js, making the UI smooth and interactive.

Installation

Follow these steps to set up and run this project locally:

Prerequisites

Ensure you have the following installed:

  • Node.js (v14+)
  • Python (v3.8+)

Backend setup (Fast API)

  1. Clone the repository:

     git clone https://github.com/Yulian302/neo-live-chat.git

  2. Navigate to the root project directory:

    cd neo-live-chat

  3. Create and activate a virtual environment:

    python3 -m venv venv
source ./venv/bin/activate

  4. Install project requirements:

    pip install -r requirements.txt

  5. Run your local server using uvicorn:

    uvicorn main:app --port [PORT] --reload

    You can use any open port. The recommended choice is 8000 as you wouldn't need to change it in your React.js app.

Frontend setup (React.js)

  1. Go to the React.js root directory: 
    cd neo-livechat/neo-livechat-React.js
  2. Install required dependencies and run the project: 
    npm i && npm start

Contributing

Contributions are what make the open-source community an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Steps to contribute:

  1. Fork the project.
  2. Create your feature branch (git checkout -b feature/[FEATURE_NAME]).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/[FEATURE_NAME]).
  5. Open a pull request.

License

Distributed under the MIT License. See LICENSE for more information.