TikTokLive-Widget: A socket client/server program that exposes a widget with alerts (such as gifts, followers ...) for a specific user streaming on Tik Tok Live platform

TikTokLive-Widget

A socket client/server program that exposes a widget with alerts (such as gifts, followers ...) for a specific user streaming on Tik Tok Live platform.


View Demo · Report Bug · Request Feature

About The Project

This program allows you to show alerts for TikTok Live events on your streaming client such as OBS or StreamLABS. The program exposes an html page where alerts can show off.

(back to top)

Built With

• NodeJS
• ExpressJS
• SocketIO (Client/Server)
• tiktok-live-connector
• JavaScript
• HTML
• Toastify

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install --global yarn

Installation

1. Clone the repo

    git clone https://github.com/Sl4yZ/tiktoklive-widget.git

2. Install NPM packages

    yarn install

3. Create a .env file at the project root (copy sample configuration in .env.example)

    # DEFINE YOUR LANGUAGE LOCALE
    CLIENT_LOCALE=en-US
   
    # DEFINE TIKTOK STREAM USERNAME
    TIKTOK_USERNAME=INSERT_HERE
   
    # DEFINE WIDGET URI
    WIDGET_URI=http://localhost
   
    # DEFINE SERVER PORT
    PORT=80
   
    # DEFINE TOAST DURATION (IN MS)
    TOAST_DURATION=500
   

4. Start the app

    yarn start

(back to top)

Usage

Work in progress...

(back to top)

Roadmap

• Server
• Client
• Events
  • Gifts Alert
  • Lottery Command
  • Messages List
  • Likes Alert
  • Questions Alert

See the open issues for a full list of proposed features (and known issues).

(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 file for more information.

(back to top)

Contact

Zayed Charef - @zayed_charef - [email protected]

Project Link: https://github.com/Sl4yZ/tiktoklive-widget

(back to top)

Acknowledgments

(back to top)