Skip to content

Latest commit

 

History

History
executable file
·
79 lines (51 loc) · 2.43 KB

PITCHME.md

File metadata and controls

executable file
·
79 lines (51 loc) · 2.43 KB

OpenChat

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

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

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.

  1. Create an empty sql database and run import database.

    create database openchat;
mysql -u[user] -p[password] [database name] < path\openchat\sql\openchat.sql

  2. To start the websocket server type

    php cmd.php

  3. Open a new terminal window and type

    gulp

That's it, now start development at http://localhost:8888 in your browser

Contribution guidelines

If you are interested in contributing to OpenChat, Open Issues and send PR.

Feel free to code and contribute