Skip to content
Chatting Platform
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Supervisor Updated Readme and conf with Supervisor Oct 1, 2017
public/assests
sql
src
tests Changes as per ubuntu Jun 29, 2017
views
.env.example
.env.travis
.gitignore Updated Readme and conf with Supervisor Oct 1, 2017
.travis.yml
CODE_OF_CONDUCT.md
LICENSE.md Changes as per ubuntu Jun 29, 2017
PITCHME.md Changes as per ubuntu Jun 29, 2017
Procfile
README.md
cmd.php
composer.json Changes as per ubuntu Jun 29, 2017
composer.lock
gulpfile.js Changes as per ubuntu Jun 29, 2017
index.php
manifest.json added manifest file for Progressive web app Nov 25, 2017
package.json Changes as per ubuntu Jun 29, 2017
phpunit.xml.dist
ruleset.xml Changes as per ubuntu Jun 29, 2017

README.md

OpenChat

Join the chat at https://gitter.im/ankitjain28may/openchat Scrutinizer Code Quality Build Status Coverage Status Code Climate Issue Count Codacy Badge GitPitch Open Source Helpers

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.

    git clone https://github.com/ankitjain28may/openchat.git
  2. Install php and js dependencies

    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.

    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

    var conn = new WebSocket("ws://external_ip:8080");
  7. Create a log file inside the root folder.

    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

    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 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

You can’t perform that action at this time.