Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
the-pesar authored Aug 22, 2024
1 parent 3094541 commit 2f52d0c
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,45 @@
Nashenas is a anonymous messaging bot for Telegram users, designed for security purposes. It allows users to send encrypted messages to each other without revealing their identities. Nashenas uses hybrid encryption (RSA + AES) similar to TLS, ensuring that messages remain secure and protected against Man-in-the-Middle (MitM) attacks. The goal is to create a safe and enjoyable platform for anonymous communication. The chart below explains the core mechanism of Nashenas in the simplest way:

![chart](https://github.com/PrivacyForge/nashenas/blob/main/chart.png)

## Deployment
This section provides the necessary guidelines for deploying the project.

### Redis
We send message notifications using Redis, so you need to set up an instance.

### Front-end
Set env variables at `.env`.

install dependencies:
```sh
bun install
```
to build:
```sh
bun run build
```

### Back-end
Set env variables at `./server/.env`.

install dependencies:
```sh
go install
```
to run:
```sh
go run main.go
```

### Telegram bot
Set env variables at `./bot/.env`.

install dependencies:
```sh
bun install
```
to run:
```sh
bun run src/index.ts
```

0 comments on commit 2f52d0c

Please sign in to comment.