Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simplito/privmx-chatee
End-to-end encrypted chat, written in Next.js.
https://github.com/simplito/privmx-chatee
chat communication end-to-end-encryption messages nextjs privacy zero-knowledge
Last synced: 5 days ago
JSON representation
End-to-end encrypted chat, written in Next.js.
- Host: GitHub
- URL: https://github.com/simplito/privmx-chatee
- Owner: simplito
- License: other
- Created: 2024-11-04T15:19:42.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-27T14:22:47.000Z (23 days ago)
- Last Synced: 2024-12-27T15:26:55.317Z (23 days ago)
- Topics: chat, communication, end-to-end-encryption, messages, nextjs, privacy, zero-knowledge
- Language: TypeScript
- Homepage:
- Size: 1.43 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Chatee
Chatee is a chat application that provides you with full end-to-end encryption using [PrivMX Bridge](https://privmx.dev).
## Basics
Chatee consist of two parts: **Web Application** and **Server Backend** (both written in Next.js).
**Server Backend** manages **user accounts** and utilizes MongoDB for persistent data storage.
All the sent messages and files are managed by [PrivMX Bridge](https://github.com/simplito/privmx-bridge), to ensure they are properly
encrypted and are not stored in your server environment.
## Features
Chatee provides essential chat features, including group chats and file attachments. All the data exchanged within Chatee is
end-to-end encrypted, meaning that only the end users can read (decrypt) their messages. It means that even the platform hosting
provider cannot access user data.
Chatee categorizes users into two distinct roles:
- **Staff**: Authorized personnel who administer user accounts and permissions.
- **Regular users**: Individuals who interact with the app's features and functionalities for communication.
All Staff users can invite others by sending them an invitation token generated inside the app. Before generating a
token you can decide whether the account will have Staff permissions or be a regular user. Regular users can create new
chats only with Staff members. Staff can add chats with all the users in the server, regardless of their status.
Chats occur in real-time. You can send text messages and files up to 50 MB.
## Requirements
- Node.js in 20.10 version.
- MongoDB instance or Docker, which allows to run our docker compose file to run the database.
- PrivMX Bridge Instance and Docker for running it.
## How to start?
To begin, clone this repository. It includes the Chatee sources along with various helpful files.
You should also copy or rename `./.env.example` to `./.env.local`. All environmental variables for local development should be put there.
### **Start MongoDB Instance**
You need a **MongoDB** Instance with replica sets for transactions.
> To proceed, ensure that Docker is up and running.
For demo purpose, you can use the `docker-compose-mongo.yml` from this repository. Run the following command to start MongoDB Docker in your local environment:
```sh
docker-compose -f docker-compose-mongo.yml up
```
It will create a MongoDB instance running on `0.0.0.0:27017` with a replica set named **rs0**.
While using Docker and the provided `docker-compose-mongo.yml` file, you can use the following lines describing connection to your local MongoDB database:
```ENV
REPLICA_SET=rs0
MONGODB_URI=mongodb://127.0.0.1:27017/?replicaSet=$REPLICA_SET
```
Feel free to adjust these settings if you opt for a custom setup.
### **Start Bridge Instance**
To set up a PrivMX Bridge instance locally clone CLI project from [here](https://github.com/simplito/privmx-bridge-docker). Follow instructions included in its README - they will create everything you need for your first app. After initialization, the terminal will output the following variables:
- **PrivMX Bridge URL** - address of the running PrivMX Bridge instance;
- **API Key ID** and **API Key Secret** - used to authorize Chatee requests to PrivMX Bridge;
- **Solution ID** - ID of the created Solution;
- **Context ID** - ID of one of the Contexts inside the Solution.
Paste them into the `./env.local` file created earlier.
### Additional Constants
#### JWT Salt
Generate a random **JWT_SALT** using e.g. `openssl`:
```sh
openssl rand -base64 20
```
and paste it into your `.env.local`.
```
JWT_SALT=GENERATED_RANDOM_SECRET
```
#### Next Public Backend URL
For demo purposes, Chatee runs in localhost (port 3000). `NEXT_PUBLIC_BACKEND_URL` configures the app's default address. In production environment, you can use a fully qualified domain name.
```ENV
NEXT_PUBLIC_BACKEND_URL=http://localhost:3000
```
## Running the App
In a new terminal, go to project root folder.
```sh
npm install
npm run dev
```
Durning the first run, Chatee server will create the first invitation token. It's important to **copy and save it somewhere**, it will be used for login.
Go to and create the first Staff user.
### Creating Threads
When creating threads (chat rooms) you are given a list of all the users from your app.
Staff users can create chats with all the users in the app.
Regular users can create chats only with Staff.
### Production Notes
#### Alternative ways to use our docker-compose-production.yml
1. Create the same .env file but name it **.env.production**.
2. Run docker-compose. Variable `PORT` will define on which port it will be available.
```sh
PORT=PORT_NUMER_OF_APPLICATION docker-compose -f docker-compose-production.yml up
```
## License
[MIT](./LICENSE)