Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/johnnymast/mysql_websocket_chat

Quickly get a websocket chat up and running
https://github.com/johnnymast/mysql_websocket_chat

boilerplate chat composer-project phpclasses private-chat project ratchet webserver websocket-chat

Last synced: about 5 hours ago
JSON representation

Quickly get a websocket chat up and running

Host: GitHub
URL: https://github.com/johnnymast/mysql_websocket_chat
Owner: johnnymast
License: mit
Created: 2016-09-16T17:39:58.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2023-07-07T23:25:45.000Z (over 1 year ago)
Last Synced: 2024-08-16T09:44:12.214Z (3 months ago)
Topics: boilerplate, chat, composer-project, phpclasses, private-chat, project, ratchet, webserver, websocket-chat
Language: PHP
Homepage:
Size: 478 KB
Stars: 21
Watchers: 4
Forks: 11
Open Issues: 18
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

[![Code Triagers Badge](https://www.codetriage.com/johnnymast/mysql_websocket_chat/badges/users.svg)](https://www.codetriage.com/johnnymast/mysql_websocket_chat)
![ESLint](https://github.com/johnnymast/mysql_websocket_chat/workflows/ESLint/badge.svg)
![StyleLint](https://github.com/johnnymast/mysql_websocket_chat/workflows/StyleLint/badge.svg)
![Phpcs](https://github.com/johnnymast/mysql_websocket_chat/workflows/Phpcs/badge.svg)

# MYSQL WEBSOCKET CHAT

Welcome to this Hackaton project I created for user hrushi on [phpclasses.org](http://www.phpclasses.org/recommend/754-I-need-to-create-realtime-user-to-user-chat.html). The idea was to create a web socket chat application
that could be logging to a database. So here is what you need to get this up and running. ***Please note*** the minimum required PHP version is 7.0- this is not because it wanted this but it is because of the dependencies this project has.

# Step 1: install composer

First thing you is installing composer on to your system. You can get composer [here](https://getcomposer.org/download/). Don't worry it might seem intimidating but it is not.

# Step 2: Install the project

## Using composer

Installing the project using composer is hands down the easiest way to get started. This method will download the project from GitHub
and automatically install its dependencies for you. Presuming you installed composer (step 1) execute the following commands on the command-line.

```bash
$ composer create-project johnnymast/mysql_websocket_chat chat
$ cd chat
```

In the above example I am using a mac so my prompt will display different then you if you are on windows.

## Downloaded from phpclasses.org

If you download this package in a zip file from [phpclasses.org](http://www.phpclasses.org/package/9947-PHP-Websocket-starter-project.html) you will have to extract the zip package to a location of your liking. Then
change directory into that directory and execute the following command on your prompt.

```bash
$ composer install
```

In the above example I am using a mac so my prompt will display different then you if you are on windows.

# Step 3: Configure the server

## Websocket configuration

This project can be split into two different components. The WebSocket server is the server.php in the root directory. The second part
is the frontend part located in public/index.php. For the WebSocket server, there are two configuration options that you can configure in includes/config.php.

#### WEBSOCKET_SERVER_IP

This flag allows you to configure the WebSocket server's IP-address. By default the value 127.0.0.1 has been set.

#### WEBSOCKET_SERVER_PORT

This will configure what port the WebSocket server will listen on. The default value has been set to 8080. You can change this
value if it clashes with other services running on your machine.

## Database configuration

This server can run either with or without a database. By default i have disabled the use of a database server (ENABLE_DATABASE) but you can enable it by switching the ENABLE_DATABASE to true
in the [includes/config.php](https://github.com/johnnymast/mysql_websocket_chat/blob/master/includes/config.php) file.

| Flag | Description |
| --- | --- |
| DATABASE_HOST | The database username goes in here. By default this has been set to root. |
| DATABASE_PORT | The database port goes in here. By default this has been set to 3306. |
| DATABASE_USERNAME | The database username goes in here. By default this has been set to root.|
| DATABASE_PASSWORD | Enter the password to access the database there. By default this has been set to root.|
| DATABASE_DB | Enter the name of the database here. By default this has been set to socket_chat.|
| ENABLE_DATABASE | This flag will turn using the database on or off by setting its value to true or false.|

***Please note*** if you enable the database make sure you update the credentials as well (see table above). Also, if you enable the database make sure you have imported [database.sql](https://github.com/johnnymast/mysql_websocket_chat/blob/master/database.sql) into your database.

# Step 4: Fire up the WebSocket server

Change direction into the chat directory and fire up the server.

```bash
$ cd chat
$ php ./server.php
```

When you see no output and the command seems to hang that's when you know its running.

# Step 5: Point a web service to the public directory

In the chat directory, you will find index.php. This file will be the client for your chat application. Make sure you set any web service its document root to the public/ folder. Alternatively, if you don't have access to a webserver you can also try using PHP's
build-in webserver.

```bash
$ cd public
$ php -S 127.0.0.1:8000
```

This will start an webserver on port 8000

# Step 6: Chat away!

Now open up 2 chat tabs and point them to localhost (or maybe a virtual host you configured) and chat away with your self.

## Functionality

#### Private chats

If you want to test private chats you can single click any user in the user list on the right of the screen. Then type your message
in the message bar, this will send a private message only to that user.

## Changes

If you wish to know what has changed in this version of Mysql WebSocket Chat you can always checkout the changelog [here](https://github.com/johnnymast/mysql_websocket_chat/blob/master/CHANELOG.md).

## Author

This package is created and maintained by [Johnny Mast](mailto:[email protected]). For feature requests or suggestions you could consider sending me an e-mail.

## Enjoy

Oh and if you've come down this far, you might as well [follow me](https://twitter.com/mastjohnny) on twitter.

## License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.