Fugu is a open source, light-weight, reliable, publish-subscribe model based real-time chat platform.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
First and foremost Node.js is required to get fugu up and running. You can install node.js via downloading official node.js package which is suitable for your environment.
Follow the instructions below to get start your own fugu on your local machine.
-
Make sure your current working directory is fugu.
-
Start local server on 3000 port(default) with dev environment configuration using command below.
NODE_ENV=dev node server.js
To run a custom environment, create a new file production.json in configuration folder and run using NODE_ENV=production node server.js command.
To change port you can use configuration at run time by specifying NODE_ENV=production PORT=<custom port> node server.js or by changing particular configuration file.
- Direct Messaging
- Multiple Chat Rooms
- Groups : Private Groups, Public Groups, General Groups
- Notification : Mobile Notifications, Desktop Notifications
- Profiling : User profile, company profile
- Highlighting : Markdown, Tagging
- Fun : Emojis, Gifs
- File sharing - images, mp3 files, pdf, excel and much more (S3 uploads)
- Search : Group Search, User Search
- ExpressJs - Fast, unopinionated, minimalist web framework for node.
- Faye - A publish-subscribe messaging system based on the Bayeux protocol.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.