manikangkan/realtime-alerts

Real time alerts is a site of clear cut demonstration of how the so called real time alerts functionality works using web sockets.

Table of Contents

• View Demo
• Report Bug
• Request Feature
• About The Project
  • Screenshots
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• License
• Contact

📢 About The Project

Real time alerts is a site of clear cut demonstration of how the so called real time alerts functionality works using web sockets.

Features -

• Like alerts
• Comment alerts.

back to top

💉 Screenshots

2022-05-21.15-52-16.mp4

🏗️ Built With

• Vite
• React.js
• Tailwind CSS
• Socket.IO

back to top

🎊 Getting Started

After successful installation of the prerequisites, choose a username from the following -

• manikangkandas
• gayatridas
• dipambitabaishyadas

You will need to open two browser windows with two different username to see the effect of real time alerts. Then if you like or comment from both the side it will show your action as alert message under notification panel another side.

⚙️ Prerequisites

Prerequisites are listed below, install in order to run the project successfully in you local machine.

• node

• git

• browser

• npm

  npm install npm@latest -g

  or

• yarn

  npm install --global yarn

🧑🏻‍🎤 Installation

1. Clone the repo

   git clone https://github.com/manikangkandas/thread-comments.git

2. Navigate to dir socket

   1. Install packages using NPM or YARN

      npm install

      or

      yarn add

   2. Run using NPM or YARN

      npm run dev

      or

      yarn dev

3. Open another terminal instance & navigate to dir client

   1. Install packages using NPM or YARN

      npm install

      or

      yarn add

   2. Run using NPM or YARN

      npm run dev

      or

      yarn dev

back to top

💁🏻‍♂️ Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

back to top

©️ License

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

back to top

🤝 Contact

Author Info - @manikankandas - manikangkan.das@outlook.com
Project Link - https://github.com/manikangkandas/thread-comments

back to top