Code Monkey home page Code Monkey logo

openchat's Introduction

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

openchat's People

Contributors

alicetragedy avatar ankitjain28may avatar codetriage-readme-bot avatar gitter-badger avatar hiteshpr avatar rjalfa avatar techiadarsh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

openchat's Issues

Dockerize

I want to make it easier to deploy this project on other platform more easily so I am thinking to integrate docker in the project.

Wrong settings key

.env.example contains wrong key DB_PASS. It should be DB_PASSWORD instead like it is used in application.

Login form add username functionality

On homepage in the Login form, We can use a username or email ID but if a username is entered which is not in email format the app shows error. We need to change the functionality of checking for email/username.

Fixed Travis

Go to the Travis log and fix the error which is breaking the build.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.