A Feathers real-time chat application
Clone or download

README.md

feathers-chat

Greenkeeper badge Build Status Dependency Status

A Feathers real-time chat application

Important: This repository requires Node v8.0.0 or later.

About

This project uses Feathers. An open source web framework for building modern real-time applications. It provides a chat API created in this guide and a frontend in plain JavaScript and jQuery.

Other chat frontends can be found at:

Getting Started

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

  1. Make sure you have NodeJS and npm installed.

  2. Install your dependencies

    cd path/to/feathers-chat
    npm install
    
  3. Start your app

    npm start
    
  4. Goto to browser and go to localhost:3030/vanilla

Testing

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

Scaffolding

Feathers has a powerful command line interface. Here are a few things it can do:

$ npm install -g feathers-cli             # Install Feathers CLI

$ feathers generate service               # Generate a new Service
$ feathers generate hook                  # Generate a new Hook
$ feathers generate model                 # Generate a new Model
$ feathers help                           # Show all commands

Help

For more information on all the things you can do with Feathers visit docs.feathersjs.com.

License

Copyright (c) 2017

Licensed under the MIT license.