https://github.com/leonacostaok/e2e-encrypted-instant-messaging

End-to-end encrypted instant messaging platform example
https://github.com/leonacostaok/e2e-encrypted-instant-messaging

chat encrypted-messaging end-to-end-encryption instant-chat instant-messaging messaging websocket-client websocket-server websockets

Last synced: 3 months ago
JSON representation

End-to-end encrypted instant messaging platform example

• Host: GitHub
• URL: https://github.com/leonacostaok/e2e-encrypted-instant-messaging
• Owner: leonacostaok
• License: mit
• Created: 2023-05-26T10:38:36.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-02-03T21:34:35.000Z (12 months ago)
• Last Synced: 2024-09-27T14:01:55.424Z (4 months ago)
• Topics: chat, encrypted-messaging, end-to-end-encryption, instant-chat, instant-messaging, messaging, websocket-client, websocket-server, websockets
• Language: TypeScript
• Homepage:
• Size: 2.71 MB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# End-to-end Encrypted Instant Messaging platform

This repository contains a client & server example that provides end-to-end encrypted instant messaging capabilities.

The code repository is split in 2, client & server. To run follow the instructions ahead in this document.

## Table of Contents

- [Getting Started](#getting-started)

    - [Requirements](#requirements)

    - [Platform design](#platform-design)

- [Troubleshooting](#troubleshooting)

## Getting Started

### Requirements

You need node.js (16.x) and yarn installed to run it locally.

Make sure all the environment variables are set up as per the `env.example` file in each repo separately (server / client).

### Platform Design

The design file can be found in the following [Figma link](https://www.figma.com/file/ZLQPd5r1rzhCUUn1C5I9Dn/E2E-Encrypted-instant-messaging-platform?type=design&node-id=103-18856&t=vX91JGTsOruV1aRn-0).

#### Server deployment

```bash

# install project dependencies

$ cd ./server & yarn install

# generate migration for local environment

$ yarn prisma:generate

# run migrations in local environment

$ yarn prisma:migrate

# run backend service

$ yarn start

```

#### Client deployment

```bash

# install project dependencies

$ cd ./client & yarn install

# run the client

$ yarn start

```

## Troubleshooting

If you have any questions, send them along with a hi to [[email protected]](mailto:[email protected]).