https://github.com/ankitjain28may/openchat
Chatting Platform
https://github.com/ankitjain28may/openchat
chatting php web-sockets
Last synced: 7 months ago
JSON representation
Chatting Platform
- Host: GitHub
- URL: https://github.com/ankitjain28may/openchat
- Owner: ankitjain28may
- License: mit
- Created: 2016-06-18T07:45:24.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-12-02T22:06:25.000Z (over 6 years ago)
- Last Synced: 2025-05-05T11:41:50.831Z (about 1 year ago)
- Topics: chatting, php, web-sockets
- Language: PHP
- Homepage:
- Size: 4.1 MB
- Stars: 26
- Watchers: 8
- Forks: 38
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# OpenChat
[](https://gitter.im/ankitjain28may/openchat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://scrutinizer-ci.com/g/ankitjain28may/openchat/?branch=master)
[](https://travis-ci.org/ankitjain28may/openchat)
[](https://coveralls.io/github/ankitjain28may/openchat?branch=master)
[](https://codeclimate.com/github/ankitjain28may/openchat)
[](https://codeclimate.com/github/ankitjain28may/openchat)
[](https://www.codacy.com/app/ankitjain28may77/openchat?utm_source=github.com&utm_medium=referral&utm_content=ankitjain28may/openchat&utm_campaign=Badge_Grade)
[](https://gitpitch.com/ankitjain28may/openchat/master?grs=github&t=moon)
[](https://www.codetriage.com/ankitjain28may/openchat)
> OpenChat is an Open Source messaging platform where people can send messages to anyone registered to this platform.
## How to Setup
Setting up OpenChat on your local machine is really easy.
Follow this guide to setup your development machine.
### Requirements :
1. PHP > 5.6
2. MySQL
3. Composer
4. npm
5. git
6. Supervisor
### Installation :
1. Get the source code on your machine via git.
```shell
git clone https://github.com/ankitjain28may/openchat.git
```
2. Install php and js dependencies
```shell
cd openchat
composer install
npm install
```
3. Rename file `.env.example` to `.env` and change credentials.
4. Create an empty sql database and run import database.
```mysql
create database openchat;
mysql -u[user] -p[password] [database name] < path\openchat\sql\openchat.sql
```
5. open .env file and set `APP_URL` to your `external_ip` address at port 8888
6. Open a `message.js` file stored at `public\assests\js` and set external_ip
```js
var conn = new WebSocket("ws://external_ip:8080");
```
7. Create a log file inside the root folder.
```shell
touch openchat_supervisor.log
```
8. Open `Supervisor\devserver.conf` and set `external_ip` address at port 8888
9. Add the conf files of the Supervisor folder to Supervisor by running following commands in terminal
```shell
sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start devserver
sudo supervisorctl start server
```
That's it, now start development at [http://external_ip:8888](http://external_ip:8888) in your browser
## Contribution guidelines
If you are interested in contributing to OpenChat, Open Issues, send PR and Don't forget to star the repo.
> Feel free to code and contribute