Skip to content

Latest commit

 

History

History
178 lines (129 loc) · 6.34 KB

README.md

File metadata and controls

178 lines (129 loc) · 6.34 KB
Raw


VibeNow

An anonymous chatting system that uses a first-come, first-serve mechanism to match pairs of users for conversations.

About The Project • Getting Started • Usage • Roadmap • Contributing • Contact • Acknowledgments


About The Project

VibeNow-demo-home

VibeNow-demo.mp4

Key Features

  • Chatting Platform: Matched users can chat with each other until they choose to exit.
  • Anonymous Pairing: Users are matched anonymously, without knowing each other's names.
  • Queue-Based Mechanism: The waiting queue operates on a first-come, first-served basis.

(back to top)

Built With

  • Angular
  • Node.JS
  • WebSocket

(back to top)

Getting Started

Installation

  1. Clone the repo

    git clone git@github.com:tsai8890/VibeNow.git

  2. Install packages

    cd frontend
npm install
    cd backend
npm install

(back to top)

Usage

  1. Run the backend

    cd backend
npm start

  2. Run the frontend

    cd frontend
npm start

(back to top)

Roadmap

  • Allow users to join the queue and wait for another person to chat
  • When users type a message, auto scroll the screen to the bottom
  • After clicking the Chat button, navigate to the chatroom page and wait.
  • Notify users in the same room when another user exits.
  • Responsive Web Design for mobile devices
  • When there're only few messages, place them from the botton to the top.

(back to top)

Contributing

If you have a suggestion that would make the project better, please fork the repo and create a pull request.
You can also simply open an issue with the tag enhancement.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Besides, if you find this project useful, don't forget to give it a star !

(back to top)

Contact

Aaron Tsai - aarontsaai@gmail.com

Project Link: https://github.com/tsai8890/LeetTimer

(back to top)

Acknowledgments

(back to top)