Skip to content

zackijack/dialogue

Repository files navigation

dialogue

Dependency Status

Real-time chat application

Getting Started

Getting it up and running is as easy as 1, 2, 3.

  1. Make sure you have NodeJS and npm installed.

  2. Clone this repository and install the dependencies

    git clone https://github.com/zackyjack/dialogue
    cd dialogue; npm install
  3. Start the application

    npm start
    # or "npm run dev" for development
    

Or with Docker, this is even easier.

  1. Clone this repository and build the Docker image

    git clone https://github.com/zackyjack/dialogue
    cd dialogue
    docker build -t <your username>/dialogue .
  2. Run the container

    docker run -p 3030:3030 -d <your username>/dialogue

Usage

API

You can easily run it in Postman with this button:

Run in Postman

Or import collections into Postman with this link.

Front-end

You just need to open localhost:3030 in the browser.

Testing

Simply run npm test and all tests in the test/ directory will be run.

Changelog

0.1.0

  • Initial release

1.0.0

  • Add user authentication
  • Add user information, including profile picture (with Gravatar)

1.1.0

  • Add frontend client

License

Copyright (c) 2016

Licensed under the MIT license.