Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/awais-amjed/encrypted-chat

Self Hosted End to End Encrypted Chat System - Created in Flutter with Appwrite as Backend
https://github.com/awais-amjed/encrypted-chat

appwrite dart flutter hackathon

Last synced: about 13 hours ago
JSON representation

Self Hosted End to End Encrypted Chat System - Created in Flutter with Appwrite as Backend

Host: GitHub
URL: https://github.com/awais-amjed/encrypted-chat
Owner: awais-amjed
Created: 2022-04-29T11:51:14.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-01-17T13:44:51.000Z (12 months ago)
Last Synced: 2024-06-01T01:57:53.105Z (8 months ago)
Topics: appwrite, dart, flutter, hackathon
Language: Dart
Homepage:
Size: 9.47 MB
Stars: 7
Watchers: 4
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

Built with Appwrite
Built with Flutter

# Encrypted Chat

> Self Hosted End to End Encrypted Chat System

#
With the power of Flutter, Appwrite, and this app, you can easily host your Encrypted chat system in a few simple steps. No more fear of being snooped on, since you have all the control over your messages that are secured using a private key - and an even more awesome thing is that it's open-source so you can modify it to make it however you want it to be. The encryption is based on public-private key pairs where the private key is generated on the device and you can keep a backup of it using a QR code generated inside the app, which makes switching devices easy without data loss. The theme is based on Appwrite's website - and everything else is just CUTE AND SECURE.

# Top Features

- End To End Encrypted
- Self Hosted
- Private and Secure
- Realtime Chat and Notifications
- Beautiful Animations & avatars

## Getting Started

To get a local copy up and running follow these steps.

# Setup Instructions

## Appwrite Installation
- Follow the steps mentioned on the official appwrite website for [instllation](https://appwrite.io/docs/installation) with docker
- In the directory where you ran the docker command, you will find a `.env` file
- Edit that file, find `_APP_FUNCTIONS_ENVS` and set it's value to `dart-2.16`
- Also delete the `_APP_FUNCTIONS_ENVS` field - Save the file
- In the same directory open a terminal or cmd and run the following command
```
docker-compose up -d
```
- This completes the docker setup

## Project Setup
- Open a browser and go to the `localhost:80` or if you set some other port
- Signup and remember the credentials - you will need them
- Create a new Project as shown below `Keep the project id as ecat` unless you want to rebuild your application.

![screenshot](./resources/project.png)

- Create an API Key with atleast these 12 permissions

![screenshot](./resources/api.png)

- Register Your Flutter Project `KEEP PACKAGE NAME AS IS` `coding.fries.ecat`

![screenshot](./resources/registration.png)

## Database and Functions

- Install the [appwrite cli](https://appwrite.io/docs/command-line)
- Open a directory and login to appwrite cli in a terminal or cmd
```
appwrite login
```
- Enter credentails used for signing up - Leave host as default unless you know what you are doing
- Download this script for [windows](./resources/create.cmd) or for [linux](./resources/create.sh)
- Run the script with following arguments
For Linux
```
./create.sh yourProjectID yourProjectName yourHost yourAPIKey
```
For Windows
```
./create.cmd yourProjectID yourProjectName yourHost yourAPIKey
```
- This will create an appwrte.json in your directory
- Now Download this [functions.zip](./resources/functions.zip) and extract in the same directory
- Run the follwing command
```
appwrite deploy --all
```
- Select all `a` and `enter` then again select all `a` and `enter`
- This will setup everything for you

# Known Bug

- The above command `appwrite deploy -all` might fail while deploying functions and give you an error `Unexpected token`
- If that's the case then you will have to create functions manually
- Open appwrite in browser `localhost:80` and go to functions
- You have to add three new functions with following ids:
```
1. createMessageCollection
2. createUserDocument
3. notifyUser
```
For all three of these you have to add these variables in the settings

![image](https://user-images.githubusercontent.com/73714615/168171851-8cce52fd-762c-4341-aa7e-53f48191c407.png)

For `createMessageCollection` and `notifyUser` add this in Execute access section:
```
role:member
```

![image](https://user-images.githubusercontent.com/73714615/168172099-7cd029af-2499-4f7a-bc77-750f3191e300.png)

and For `createUserDocument` check the account.create event

![image](https://user-images.githubusercontent.com/73714615/168172332-72fcf10d-4937-4320-bab4-a394051fe608.png)

- Now run these [commands](./resources/commands.txt) one by one in the same directory where you have the appwrite.json and functions
- After this all your functions will be deployed

## Usage

Download the apk, install and Open your app - Set your setup information by clicking the settings icon on the login screen - Enjoy free and private encrypted chat

# Future Improvements

- Multi Platform Support - especially Web
- Push Notifications implementation (when appwrite releases support or maybe using firebase)
- File Transfer - soon
- Message Data Persistance

## Authors

👤 **Awais Amjed**

- GitHub: [@Awais Amjed](https://github.com/awais-amjed)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/awais-amjed)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- FlatIcons - All images used are from [Flaticon](https://www.flaticon.com/) - Love their collections ❤️

## Attributions