https://github.com/simplyhexagonal/fastify-chat-server
Simple Websockets chat server including client UI
https://github.com/simplyhexagonal/fastify-chat-server
Last synced: about 1 year ago
JSON representation
Simple Websockets chat server including client UI
- Host: GitHub
- URL: https://github.com/simplyhexagonal/fastify-chat-server
- Owner: simplyhexagonal
- Created: 2023-09-06T09:01:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-14T02:19:46.000Z (over 2 years ago)
- Last Synced: 2025-05-06T20:24:30.649Z (about 1 year ago)
- Language: CSS
- Size: 1.3 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
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](https://www.fastify.io/) - HTTP Server
- [Vue JS](https://vuejs.org/) - UI Markup
- [Tailwind CSS](https://tailwindcss.com/) - UI Styles
- [Axios](https://axios-http.com/) - Client HTTP Requests
- [Remix Icon](https://remixicon.com/) - Icons
## Open source notice
This project is part of the [Open Collective](https://opencollective.com/simplyhexagonal) project [Simply Hexagonal](https://simplyhexagonal.org)
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](#contributors-) âïļ ! See the [contributing section](#contributing).
## Like this module? âĪ
Please consider:
- [Buying me a coffee](https://www.buymeacoffee.com/jeanlescure) â
- Supporting me on [Patreon](https://www.patreon.com/jeanlescure) ð
- Starring this repo on [Github](https://github.com/simplyhexagonal/fastify-chat-server) ð
## 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](https://developers.giphy.com/docs/api/#quick-start-guide) ðïļ
- 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:
```sh
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:
```sh
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](https://allcontributors.org/docs/en/emoji-key)):
## License
Copyright (c) 2023-Present [Fastify Chat Server Contributors](https://github.com/simplyhexagonal/fastify-chat-server/#contributors-).
Licensed under the [Apache License 2.0](https://www.apache.org/licenses/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
