https://github.com/canop/miaou

A chat server with OAuth2 authentication, persistent and searchable history, video and audio, markdown formatting, private and public rooms, stars, votes, embedded games, and many other features
https://github.com/canop/miaou

chat javascript nodejs postgresql redis svg

Last synced: 2 days ago
JSON representation

A chat server with OAuth2 authentication, persistent and searchable history, video and audio, markdown formatting, private and public rooms, stars, votes, embedded games, and many other features

• Host: GitHub
• URL: https://github.com/canop/miaou
• Owner: Canop
• License: other
• Created: 2013-11-14T17:35:18.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-11-10T08:13:38.000Z (about 1 month ago)
• Last Synced: 2024-12-14T11:04:21.012Z (9 days ago)
• Topics: chat, javascript, nodejs, postgresql, redis, svg
• Language: JavaScript
• Homepage: http://miaou.dystroy.org/
• Size: 19.9 MB
• Stars: 545
• Watchers: 27
• Forks: 73
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: license.md

Awesome Lists containing this project

README

        

![Miaou](src/rsc/Miaou.svg)

A chat server with authentication, persistent and searchable history, rich markdown formatting, video, private rooms, conversation highlighting, plugins, persisted notifications, code and table rendering, specialized link boxing, github hooks, bots, and many other features.

![screenshot](https://i.imgur.com/gqHo9Mu.png)

[![Chat on Miaou](https://miaou.dystroy.org/static/shields/room-en.svg?v=1)](https://miaou.dystroy.org/1?Miaou)

[![Chat on Miaou](https://miaou.dystroy.org/static/shields/room-fr.svg?v=1)](https://miaou.dystroy.org/3?Code_Croissants)

**[Introduction/Gallery](http://miaou.dystroy.org/static/intro.html)**

You can see it in action or use it on https://miaou.dystroy.org (anybody can create a room for public or private use on this server).

# Installing a server

If you want to install Miaou, the installation documentation is available [here](installation.md).

Don't hesitate to come ask us some advices in one of the dedicated chat rooms [![Chat on Miaou](https://miaou.dystroy.org/static/shields/room-en.svg?v=1)](https://miaou.dystroy.org/1?Miaou) and [![Chat on Miaou](https://miaou.dystroy.org/static/shields/room-fr.svg?v=1)](https://miaou.dystroy.org/3?Code_Croissants) (please note that they're currently more active between 8 and 19 GMT).

And if you run your own server, please tell us, we're always happy to learn about installations.

# Contributing

As described in [the help](https://miaou.dystroy.org/help#Technical_Stack), Miaou is mostly coded in JavaScript.

Stuff includes node, PostgreSQL, OAuth2, socket.io, WebRTC, express, Bluebird, Redis, Pug, Passport.js, hu.js, jQuery, sass/scss, travis-ci, and nginx.

Many features are implemented as plugins, and that's where you should look first: [Plugin developpement](plugins/README.md).

If you have the ability and will to contribute, come and discuss with us. The best landing place is usually the [Miaou room](http://miaou.dystroy.org/1?Miaou) where you can ping @dystroy or @Florian.

Help is welcome but remember:

1. Come and discuss with us before to code

2. And, **always test yourself and run the test suite before doing a pull request**.

## License

Most of Miaou follows the [MIT License](http://opensource.org/licenses/MIT). Exceptions are specified [here](license.md).

Copyright (c) 2014 Denys Séguret <[https://www.dystroy.org/](https://www.dystroy.org/)>