https://github.com/syntaxlexx/sveltekit-soketi-fastify-prisma-demo
A Chat-rooms app built with Sveltekit, Fastify,Soketi (with Pusher SDK), Prisma, and Zod. Public, presence, and private channels.
https://github.com/syntaxlexx/sveltekit-soketi-fastify-prisma-demo
fastify prisma pusher soketi sveltekit tailwindcss zod
Last synced: 3 months ago
JSON representation
A Chat-rooms app built with Sveltekit, Fastify,Soketi (with Pusher SDK), Prisma, and Zod. Public, presence, and private channels.
- Host: GitHub
- URL: https://github.com/syntaxlexx/sveltekit-soketi-fastify-prisma-demo
- Owner: syntaxlexx
- License: mit
- Created: 2023-06-18T01:37:51.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-29T00:30:19.000Z (almost 2 years ago)
- Last Synced: 2025-02-01T05:03:22.875Z (3 months ago)
- Topics: fastify, prisma, pusher, soketi, sveltekit, tailwindcss, zod
- Language: Svelte
- Homepage: https://acelords.com
- Size: 701 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Soketi-Fastify Chat App
A sample and kinda-unique Chat App build after peer-pressure from [Twitter](https://twitter.com/syntaxlexx) that (allegedly):
- `Fastify` is faster than `Express`
- `Soketi` is also faster than `Pusher`, `Socket.io`
- `Redis` is...well, Redis!
- `Sveltekit` performs arguably better than `React`,`Next`,`Nuxt`,`Jquery` (huh?!) with better syntax
- `Twitter` is better than `Masterdon`
And oh-boy! Do I also have a 2016 Pc that barely notices the first 3 claims!
> You're sure your new M1 MBP will notice it?
As for React ....... they ain't lying!
## Quick Docs
### Node Server
Start the server by running:
```bash
node server
```
### Prisma
Create migration
```bash
npx prisma migrate dev --name init
npx prisma studio
npx prisma studio --browser none
```
### Soketi
Install using Docker. Honestly, why would you not use docker?!
```bash
docker run -p 6001:6001 -p 9601:9601 quay.io/soketi/soketi:1.4-16-debian
```
### S3 Uploads
For testing s3 uploads without necessarily creating an AWS account, here we use the [s3rver](https://github.com/jamhall/s3rver) testing library. Simply run
```bash
node backend/s3.js
```
All files are stored in the `./tmp/s3-test` folder.
When deploying, you can use cheaper or self-hosted options that support **S3-compatible** API, e.g. [minio](https://github.com/minio/minio)
## In-Thoughts & Architecture
- **Sveltekit** handles the authentication/authorization in the SPA/SSR-side-of-life.
- **Fastify(Node**) handles the API-side, that is the websockets/pusher side-of-life. To prevent multiple/redundant authentications, we pass the `cookie` from Sveltekit as an `access_token` header when sending messages to the **node backend**.
- Arguably, the entire `SSR` can be made an `SPA` by just issuing `JWT tokens / access_tokens` from the **node backend**. I just prefer keeping the **node backend** light on its duties, and let **Sveltekit** do what its best at: *everything else!*.
## After-thoughts
The nature of `Pub/Sub` is really not bad for small-to-medium scale apps as compared to `Bidirectional Streaming`. For faster authentication of websocket, short-lived JsonWebTokens are a perfect and fast authentication mechanism.
**Soketi** is mostly advertised and/or used with Laravel, but has been proven to work with other projects. It is **INSANELY** fast when you test on your own.
However, for truly fast-paced live-chats, it would be better sticking to **bidirectional** Websockets, [As explained here](https://stackoverflow.com/questions/53689633/can-google-pub-sub-be-used-for-chat-messaging), [and here](https://ably.com/topic/pusher-vs-websockets), [and this too.](https://stackoverflow.com/questions/71746954/pub-sub-vs-bidirectional-streaming-in-grpc-for-chat-service)
.. or use a service such as [**Ably**](https://ably.com/)!
## The Normal, Boring Docs
> Boring is good
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
### Creating a project
If you're seeing this, you've probably already done this step. Congrats!
```bash
# create a new project in the current directory
npm create svelte@latest
# create a new project in my-app
npm create svelte@latest my-app
```
### Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```bash
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
### Building
To create a production version of your app:
```bash
npm run build
```
You can preview the production build with `npm run preview`.
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
## Credits
- (AceLords)(https://acelords.com)
- (SyntaxLexx)(https://twitter.com/syntaxlexx)
- Human Brain
## Todo
- [x] Add Emojis
- [ ] Add file and image uploads
- [ ] Add Video chat (WebRTC)
- [ ] Invite links to private chats
- [ ] Hide private chats from non-members (participants)
- [ ] Add limitations to chat rooms, e.g. max_members
- [ ] Group admins can add and remove members
- [ ] Chat creators can delete chat-rooms
- [ ] Join private and group chats via QR code
- [ ] Join private and group chats via PIN/code
- [ ] Join private and group chats via Email
## Screenshots
