@simplyhexagonal/fastify-chat-server
v1.2.0
Published
Simple Websockets chat server including client UI
Downloads
6
Readme
Fastify Chat Server 💬
Fastify Chat Server provides a simple yet blazing fast file browser UI for viewing and downloading local files within the working directory where you run it.
Built using:
- Fastify - HTTP Server
- Vue JS - UI Markup
- Tailwind CSS - UI Styles
- Axios - Client HTTP Requests
- Remix Icon - Icons
Open source notice
This project is part of the Open Collective project Simply Hexagonal and is open to updates by its users, we ensure that PRs are relevant to the community. In other words, if you find a bug or want a new feature, please help us by becoming one of the contributors ✌️ ! See the contributing section.
Like this module? ❤
Please consider:
- Buying me a coffee ☕
- Supporting me on Patreon 🏆
- Starring this repo on Github 🌟
Features
- Lightweight 🪶
- Self-contained 📦
- Simple and fast UI ✨
- Light and Dark theme 🌗
- Ability to secure chat rooms with password 🔒
- Ability to store chat history 💾
- GIF support through Giphy API 🎞️
- Mobile friendly UI 📱
Usage
Using NPX:
npx @simplyhexagonal/fastify-chat-server
Installing globally:
npm i --global @simplyhexagonal/fastify-chat-server
fastify-chat-server
Optionally you can set other options using CLI arguments:
Options:
--version Show version number [boolean]
--port Port number to listen on [number] [default: 3000]
--host Host name to bind to (use '0.0.0.0' to expose to the netw
ork) [string] [default: "127.0.0.1"]
--store Store chat messages in chats.json
[boolean] [default: false]
--giphy-api-key Giphy API key (https://developers.giphy.com/docs/api/)
[string] [default: ""]
-h, --help Show help [boolean]
And environment variables via export
command or .env
file:
GIPHY_API_KEY=e2aBcDeFgHiJkLmNoPqRsT1234567890
STORE_CHAT=true
Contributing
Yes, thank you! This plugin is community-driven, most of its features are from different authors.
Please update the docs and tests and add your name to the package.json
file.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
License
Copyright (c) 2023-Present Fastify Chat Server Contributors. Licensed under the Apache License 2.0.
For your convenience, here is a list of all the licenses of this package's dependencies:
- Apache-2.0
- MIT
- ISC
- BSD-3-Clause
- BSD-2-Clause