https://github.com/sama-communications/sama-server
SAMA - Simple but Advanced Messaging Alternative chat server, powered by uWebsockets.js
https://github.com/sama-communications/sama-server
chat chat-application chat-server chatserver nodejs websocket xmpp xmpp-server
Last synced: 12 months ago
JSON representation
SAMA - Simple but Advanced Messaging Alternative chat server, powered by uWebsockets.js
- Host: GitHub
- URL: https://github.com/sama-communications/sama-server
- Owner: SAMA-Communications
- License: gpl-3.0
- Created: 2022-09-19T12:07:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-10T14:40:30.000Z (over 1 year ago)
- Last Synced: 2024-12-10T22:31:05.352Z (over 1 year ago)
- Topics: chat, chat-application, chat-server, chatserver, nodejs, websocket, xmpp, xmpp-server
- Language: JavaScript
- Homepage: https://samacloud.io
- Size: 1.3 MB
- Stars: 113
- Watchers: 4
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Roadmap: docs/ROADMAP.md
Awesome Lists containing this project
README
# SAMA - Simple but Advanced Messaging Alternative - Chat server
#### Powered by [`uWebSockets.js`](https://github.com/uNetworking/uWebSockets.js/)
[](https://github.com/SAMA-Communications/sama-server/commits/main)
[](https://github.com/SAMA-Communications/sama-server/issues)
[](https://github.com/SAMA-Communications/sama-server/stargazers)
[](https://github.com/SAMA-Communications/sama-server/blob/master/LICENSE)
## Motivation
The intention of our messaging protocol and chat server, which are different from others, is to provide an alternative solution to the wide spread XMPP messaging protocol (and to be honest — the only wide spread ‘standard’ these days).
Read complete medium posts **Introducing SAMA** and **What is SAMA** about what is SAMA and what problems we are trying to solve with it:
- https://medium.com/sama-communications/introducing-sama-simple-but-advanced-messaging-alternative-chat-server-524a532e2040
- https://medium.com/sama-communications/what-is-sama-a6d9045fd69a
Clients:
- Frontend Web app https://github.com/SAMA-Communications/sama-client
- Flutter app https://github.com/SAMA-Communications/sama-client-flutter
## Local development
- Make sure you have latest `Node 18` installed.
- Copy `.env.example` to `.env`.
- Run `docker-compose -f docker-compose.yml -f docker-compose.development.yml up` to run dependant services (MongoDB, Minio, Redis)
- `npm install` to install dependencies
- `npm run migrate-mongo-up` to run DB migrations
- `npm run start` to run server (in a case of running under Windows - see https://github.com/SAMA-Communications/sama-server/issues/128)
- Now the server will be listening for incoming connections at `ws://localhost:9001`
There are also other components available in SAMA stack - check it out [Deploying SAMA chat server stack: a comprehensive guide](https://medium.com/sama-communications/deploying-sama-chat-server-stack-a-comprehensive-guide-294ddb9a2d78)
## Deployment
Deploying the SAMA application can be done easily with Docker, whether you want a complete setup with all dependencies or a local environment with the main applications. Below are the steps to follow:
### Docker one-command deployment
This approach builds and runs the entire SAMA application, including all dependencies, in a single command. It is ideal for setting up the full environment quickly.
To deploy using this method, run:
```
docker-compose -f docker-compose-full.yml up --build
```
### Docker local deployment
To run the dependency services along with the main `SAMA` applications (`sama-client`, `sama-server`, and `sama-push-daemon`), use:
```
docker-compose up --build
```
:warning: If you are using MacOS or Windows, and want run `SAMA` apps, add these two variables before the launch command:
MacOS
```
MINIO_ENDPOINT=$(ipconfig getifaddr en0) MINIO_PORT=9010
```
Windows
```
$env:MINIO_ENDPOINT = (Get-NetIPAddress | Where-Object { $_.AddressFamily -eq 'IPv4' -and $_.IPAddress -match '^192\.168\.|^10\.|^172\.(1[6-9]|2[0-9]|3[0-1])\.' } | Select-Object -ExpandProperty IPAddress)[1]; $env:MINIO_PORT = 9010;
```
If you are encountering issues with attachments in the web client, it suggests that an error occurred in the first variable. To resolve this, you can simply update the code segment with the private IP address of your machine.
Now you can access apps at the following addresses:
- [Server-API](http://localhost:9000)
- [Web-Client](http://localhost:10000)
- [Minio-API](http://localhost:9010)
- [Minio-Client](http://localhost:9011)
- [Push-dashboard](http://localhost:3001/ui)
- [Server-dashboard](http://localhost:9002)
- [Redis-commander](http://localhost:8081)
### Docker e2e tests
Run migrations:
```
docker-compose exec sama-server sh -c "MONGODB_URL=mongodb://172.25.0.4/samatests npm run migrate-mongo-up"
```
Run e2e tests:
```
docker-compose exec sama-server sh -c "MONGODB_URL=mongodb://172.25.0.4/samatests npm run test"
```
## Public cloud DEMO
The whole SAMA stack can be tested using https://app.samacloud.io public cloud.
## API
[API reference](docs/API.md)
Also, there is a set of detailed articles for each API:
- [Users API](https://medium.com/sama-communications/sama-chat-server-api-users-edf65ea6a341)
- [Conversations API](https://medium.com/sama-communications/sama-chat-server-api-conversations-1ae505b07d17)
- [Messages API](https://medium.com/sama-communications/sama-chat-server-api-messages-dc00e9684dc0)
- [Activities API](https://medium.com/sama-communications/sama-chat-server-api-activities-97b712b88671)
- [Address Book API](https://medium.com/sama-communications/sama-chat-server-api-address-book-f297ce25faa1)
- [Push Notifications API](https://medium.com/sama-communications/sama-chat-server-api-push-notifications-7e904eb04a0c)
## Custom DI container
An example how to create and use provider:
1. Create folder `app/providers/services/my_provider` with 2 files `index.js` and `Provider.js`
2. `index.js` should contain the implementation of the service itself:
```js
export default class MyProvider {
constructor(redisConnection, userRepo) {
this.redisConnection = redisConnection
this.userRepo = userRepo
}
async updateAction(ws, fields) {
const id = await this.redisConnection.client ...
const updatedUser = await this.userRepo.update ....
....
return updatedUser
}
}
```
3. `Provider.js` should export an instance of RegisterProvider which contains instructions how to create an instance of `index.js` class with dependencies:
```js
import RegisterProvider from "@sama/common/RegisterProvider.js"
import MyProvider from "./index.js"
const name = "MyProvider"
class MyProviderRegistration extends RegisterProvider {
register(slc) {
const redisConnection = slc.use("RedisClient")
const userRepo = slc.use("UserRepository")
return new MyProvider(redisConnection, userRepo)
}
}
export default new MyProviderRegistration({ name, implementationName: MyProvider.name })
```
4. Then, add export of `Provider.js` to `app/providers/index.js`
```js
import UserRepoProvider from "./repositories/user/Provider.js"
...
...
import MyProviderRegistration from "./services/my_provider/Provider.js"
const providers = [
UserRepoProvider,
...
...
MyProviderRegistration
]
export default providers
```
5. For any custom APIs providers - use `/APIs/[API_NAME]/providers/index.js` file:
6. And now yiou can use `MyProvider` class where needed, e.g. in controller:
```js
import ServiceLocatorContainer from "@sama/common/ServiceLocatorContainer.js"
class Controller {
async edit(ws, data) {
const myProvider = ServiceLocatorContainer.use("MyProvider")
const updatedUser = await myProvider.updateAction(ws, data)
....
}
}
```
## Community and Support
Join our community for support and discussions:
- [GitHub Issues - SAMA server](https://github.com/SAMA-Communications/sama-server/issues), [GitHub Issues - SAMA client](https://github.com/SAMA-Communications/sama-client/issues), [GitHub Issues - SAMA Flutter client](https://github.com/SAMA-Communications/sama-client-flutter/issues)
- [SAMA on Medium](https://medium.com/sama-communications)
- Get help - [Discord 💬](https://discord.gg/bHSm9a7DpC)
## Roadmap
[Roadmap](docs/ROADMAP.md)
## License
[GPL-3.0](LICENSE)
## Help us!
Any thoughts, feedback is welcome! Please create a GitHub issue for any feedback you have.
Want to support us?
