README.md

feathers-chat

A FeathersJS chat application

About

This project uses Feathers, a framework for real-time applications and REST APIs. It contains the chat application created in the Feathers guide and a frontend in plain JavaScript.

Other chat frontends can be found at:

• TypeScript: feathersjs/feathers-chat-ts
• React: feathersjs-ecosystem/feathers-chat-react
• React Native: feathersjs-ecosystem/feathers-react-native-chat
• Angular: feathersjs-ecosystem/feathers-chat-angular
• VueJS with Vuex: feathers-plus/feathers-chat-vuex

Important: This project requires NodeJS 10 or later.

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
   

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 @feathersjs/cli          # Install Feathers CLI

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

Help

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