/treblechat

Primary LanguageJavaScriptMIT LicenseMIT

build status service-test status coverage Total alerts commits to be deployed chat on Discord


#TrebleChat


Explore the docs »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact

About The Project

Logo

This application could serve as a prototype for a Twitter extension because it allows you to chat with Twitter users in real time according to the indicated trend.

  • The user must log in with their Twitter username and indicate the trend in which they are interested.

  • Once the user has logged in, they will be automatically redirected to the corresponding chat room according to the indicated trend.

  • In this way all users interested in this trend will be redirected to the same room.

  • Once inside the room users will see all online users with their respective Twitter account names and will also be informed of the users who enter and leave the room in real time.

Built With

Getting Started

Installation

To run the app locally just follow the next steps:

  • Download the files or clone the repo.

  • Install node modules in the main directory

   npm install
  • Go to server directory
  cd server
  • Run the app
  node server.js
  • Access your local server on 3000 port.

Prerequisites

Get NodeJS.

  • npm
    npm install npm@latest -g

Contributing

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

  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

License

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

Deployment

This app has been deployed in the cloud using Heroku. So you can access to this app just going to https://treblechat.herokuapp.com/

Contact

Lope Martínez Alcalá - @lopemaal - martinezalcala@hotmail.com

Project Link: https://github.com/your_username/repo_name